NASA PDS 联邦API

PDS致力于开发适用于所有在线Web应用程序的REST-ful Web API，包括数据搜索和DOI管理。

此存储库是NASA PDS联邦API规范（例如，遵循OpenAPI标准）及其文档的入口点。

请访问我们的网站https://nasa-pds.github.io/pds-api/以获取用户文档。

先决条件

• Python 3

• 对于PDF生成，需要basiclatex及其相关库

  brew install basictex
  sudo /Library/TeX/texbin/tlmgr update --self
  sudo /Library/TeX/texbin/tlmgr install latexmk
  sudo /Library/TeX/texbin/tlmgr install tex-gyre
  sudo /Library/TeX/texbin/tlmgr install fncychap
  sudo /Library/TeX/texbin/tlmgr install wrapfig
  sudo /Library/TeX/texbin/tlmgr install capt-of
  sudo /Library/TeX/texbin/tlmgr install framed
  sudo /Library/TeX/texbin/tlmgr install needspace
  sudo /Library/TeX/texbin/tlmgr install tabulary
  sudo /Library/TeX/texbin/tlmgr install varwidth
  sudo /Library/TeX/texbin/tlmgr install titlesec
  

生成用户文档

在docs/source/conf.py中设置总体版本（例如，构建号）

未解决的OpenAPI yaml规范存储在specs目录中。

规范的命名如下：PDS_APIs-{应用}-{版本}-swagger.yaml

例如：PDS_APIs-registry-1.0.0-swagger.yaml

要添加新的规范或规范的新版本

1. 按照上述文件名约定，将OpenAPI规范复制到specs目录下。

2. 在docs/source/specifications.rst中为此文件添加新条目

3. 在文件docs/source/conf.py中，在redoc对象中为新的规范添加一个部分。

4. 生成文档的PDF。

   cd docs/
   make latexpdf
   cp build/latex/pdsapis.pdf build/html/_static
   

5. 生成Sphinx文档

   pip install -e '.[dev]'
   
   sphinx-build -b html docs/source docs/build/html
   

行为准则

NASA-PDS软件的所有用户和开发者都应遵守我们的行为准则。请阅读此内容以确保您了解我们社区的要求。

开发

要开发此项目，请使用您喜欢的文本编辑器，或具有Python支持的集成开发环境，如PyCharm。

贡献

有关如何为NASA-PDS代码库做出贡献的信息，请参阅我们的贡献指南。

CI/CD

模板存储库包含我们两个“标准”CI/CD工作流程，stable-cicd和unstable-cicd。不稳定构建在向main推送时运行（±忽略对特定文件的更改）并且稳定构建在推送形式为release/<发布版本>的发布分支时运行。这两个工作流程都使用我们的GitHub动作构建步骤，Roundup。unstable-cicd将生成（并持续更新）快照发布。如果您尚未进行正式的软件发布，您将得到一个v0.0.0-SNAPSHOT发布（有关具体信息，请参阅NASA-PDS/roundup-action#56）。