CLOUDP-322242: Add Service account curl example to OAS #742
Conversation
| { | ||
| Lang: "cURL", | ||
| Label: "curl", | ||
| Label: "curl (Service Account)", |
There was a problem hiding this comment.
all test.go files were updated for e2e tests
|
|
||
| echo "Running FOAS CLI versions command" | ||
| foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}" --stability-level stable --stability-level preview | ||
| foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}" --stability-level stable --stability-level preview --stability-level upcoming |
There was a problem hiding this comment.
drive by fix to list upcoming api versions in the version.json file
| f.newServiceAccountCurlCodeSamplesForOperation(pathName, opMethod), | ||
| f.newDigestCurlCodeSamplesForOperation(pathName, opMethod), |
There was a problem hiding this comment.
the main change is here
|
|
||
| return codeSample{ | ||
| Lang: "cURL", | ||
| Label: "curl (Service Account Access Token)", |
There was a problem hiding this comment.
could the label be shorter but still helpful?
There was a problem hiding this comment.
CC @gssbzn since he proposed the name (before it was Service Account). Is Service Account too generic? Could Service Account mean something else than Access Token in this context?
There was a problem hiding this comment.
i was about to propose that :-) if you see the screenshot in the PR description, it seems too long, but ok if we think this is the shortest label that makes it understable
There was a problem hiding this comment.
I see in the Spec we have Service accounts (oauth2) (https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/) so I can use Service accounts - oauth2 which is shorter but still long.
I am going to update it to Service accounts - oauth2 for consistency and see if it is still too long.
There was a problem hiding this comment.
I asked our PM for his preference in https://mongodb.slack.com/archives/C02FHQ614UR/p1749032541122489. Let's wait and see
There was a problem hiding this comment.
my fear with just service account is that you don't use the service account you need to get an access token, it would be good if we could link to how to get the access token but I'm not sure if that's possible on examples
There was a problem hiding this comment.
would be good if we could link to how to get the access token but I'm not sure if that's possible on examples
This is the only way I have to add link:
There was a problem hiding this comment.
- Use the name "Service Accounts" for curl examples
- Include the AtlasCLI example first in the list
1) Use the name "Service Accounts" for curl examples 2) Include the AtlasCLI example first in the list
4 participants
Proposed changes
CLOUDP-322242
Description
This PR adds curl request examples using Service account to all the endpoints.