Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rest API tweaks for docs #6182

Merged
merged 3 commits into from
Apr 12, 2023
Merged

Rest API tweaks for docs #6182

merged 3 commits into from
Apr 12, 2023

Conversation

osfameron
Copy link
Contributor

@osfameron osfameron commented Apr 12, 2023 •
edited
Loading

CBG-0000

Describe your PR here...

  • Added operationId to allow docs to generate references and links from the Configuration pages
  • tidy-up Public Only Endpoints
  • added the CI/CD check that Ben mentioned

Inviting @bbrks and @IsaacLambat to review and merge.

Pre-review checklist

  • Removed debug logging (fmt.Print, log.Print, ...)
  • Logging sensitive data? Make sure it's tagged (e.g. base.UD(docID), base.MD(dbName))
  • Updated relevant information in the API specifications (such as endpoint descriptions, schemas, ...) in docs/api

Dependencies (if applicable)

  • Link upstream PRs
  • Update Go module dependencies when merged

Integration Tests

@osfameron
Remove "Public Only Endpoints" tag.
e120e7a 
OpenAPI-Generator doesn't give nice output with multiple tags.
(e.g. it generates multiple copies of the same link in the
generated navigation)

As discussed with Ben & Isaac, the multiple tags aren't hugely
important so we've already removed in most places, but looks
like I missed Public Only Endpoints in my previous commit.
@osfameron
Add operationId to all operations.
536531c 
This is recommended by OpenAPI Spec, and makes openapi-generator
and some of the Docs tooling happy.

I've generated these based on the METHOD + FILENAME and updated
in batch with a bash + yq script.
@osfameron
Update .redocly.yaml
0185bd0 
As advised by @bbrks as this will verify that all endpoints have an
operationID.
@bbrks bbrks merged commit 469b1e7 into couchbase:master Apr 12, 2023
torcolvin pushed a commit that referenced this pull request May 16, 2023
@osfameron @torcolvin
Rest API tweaks for docs (#6182)
fc99c68 
* Remove "Public Only Endpoints" tag.

OpenAPI-Generator doesn't give nice output with multiple tags.
(e.g. it generates multiple copies of the same link in the
generated navigation)

As discussed with Ben & Isaac, the multiple tags aren't hugely
important so we've already removed in most places, but looks
like I missed Public Only Endpoints in my previous commit.

* Add operationId to all operations.

This is recommended by OpenAPI Spec, and makes openapi-generator
and some of the Docs tooling happy.

I've generated these based on the METHOD + FILENAME and updated
in batch with a bash + yq script.

* Update .redocly.yaml

As advised by @bbrks as this will verify that all endpoints have an
operationID.
torcolvin pushed a commit that referenced this pull request May 16, 2023
@osfameron @torcolvin
Rest API tweaks for docs (#6182)
bf4f702 
* Remove "Public Only Endpoints" tag.

OpenAPI-Generator doesn't give nice output with multiple tags.
(e.g. it generates multiple copies of the same link in the
generated navigation)

As discussed with Ben & Isaac, the multiple tags aren't hugely
important so we've already removed in most places, but looks
like I missed Public Only Endpoints in my previous commit.

* Add operationId to all operations.

This is recommended by OpenAPI Spec, and makes openapi-generator
and some of the Docs tooling happy.

I've generated these based on the METHOD + FILENAME and updated
in batch with a bash + yq script.

* Update .redocly.yaml

As advised by @bbrks as this will verify that all endpoints have an
operationID.
torcolvin added a commit that referenced this pull request May 16, 2023
@torcolvin @osfameron
Rest API tweaks for docs (#6182) (#6249)
32acb87 
* Remove "Public Only Endpoints" tag.

OpenAPI-Generator doesn't give nice output with multiple tags.
(e.g. it generates multiple copies of the same link in the
generated navigation)

As discussed with Ben & Isaac, the multiple tags aren't hugely
important so we've already removed in most places, but looks
like I missed Public Only Endpoints in my previous commit.

* Add operationId to all operations.

This is recommended by OpenAPI Spec, and makes openapi-generator
and some of the Docs tooling happy.

I've generated these based on the METHOD + FILENAME and updated
in batch with a bash + yq script.

* Update .redocly.yaml

As advised by @bbrks as this will verify that all endpoints have an
operationID.

Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
bbrks pushed a commit that referenced this pull request May 16, 2023
@torcolvin @osfameron
Backport rest API tweaks for docs (#6182) to release/3.1.0 (#6248)
01e4989 
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbrks bbrks bbrks approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@osfameron @bbrks