harbor/api/harbor
Steven Zou 0cf3793297 doc[compatibility]:add doc ref in the README
- refer the harbor compatibility doc in the README
- add .md suffix to the README file under api/harbor

Signed-off-by: Steven Zou <szou@vmware.com>
2019-12-12 18:43:49 +08:00
..
README.md doc[compatibility]:add doc ref in the README 2019-12-12 18:43:49 +08:00
swagger.yaml doc[api spec]:rename folder name to 2019-12-09 18:48:10 +08:00

References

This file lists all the files that are referring the swagger yaml file.

  • Makefile
    • java -jar swagger-codegen-cli.jar generate -i api/harbor/swagger.yaml -l python -o harborclient
  • README
    • Harbor RESTful API in API section
  • docs/configure_swagger.md
    • https://raw.githubusercontent.com/goharbor/harbor/master/api/harbor/swagger.yaml
  • make/photon/portal/Dockerfile
    • COPY ./api/harbor/swagger.yaml /build_dir
  • tests/swaggerchecker.sh
    • HARBOR_SWAGGER_FILE="https://raw.githubusercontent.com/$TRAVIS_REPO_SLUG/$TRAVIS_COMMIT/api/harbor/swagger.yaml"
    • else HARBOR_SWAGGER_FILE="https://raw.githubusercontent.com/$TRAVIS_PULL_REQUEST_SLUG/$TRAVIS_PULL_REQUEST_SHA/api/harbor/swagger.yaml"

Notes: Base path is the code repository root dir.