Skip to content

GT-123 Update example READ API output#14

Merged
gregcorbett merged 6 commits into
mainfrom
12-update-example-read-api-output
Mar 1, 2023
Merged

GT-123 Update example READ API output#14
gregcorbett merged 6 commits into
mainfrom
12-update-example-read-api-output

Conversation

@rowan04

@rowan04 rowan04 commented Nov 23, 2022 •
edited by gregcorbett
Loading

Copy link
Copy Markdown
Contributor

Resolves #12

Waiting on GOCDB/gocdb#394

@rowan04 rowan04 requested a review from gregcorbett November 23, 2022 14:25
tofu-rocketry
tofu-rocketry reviewed Jan 3, 2023
View reviewed changes
Comment thread api/read/get_service/index.md Outdated
Comment thread api/read/get_roc_contacts/index.md Outdated
@gregcorbett

gregcorbett commented Jan 3, 2023

Copy link
Copy Markdown
Member

Once GOCDB/gocdb#394 is merged, as second pass of this will be needed to ensure each method's example XML API output reflects the new sample data - that will include escaping aditional &, see #14 (comment).

@rowan04

rowan04 commented Feb 6, 2023

Copy link
Copy Markdown
Contributor Author

Once GOCDB/gocdb#394 is merged, as second pass of this will be needed to ensure each method's example XML API output reflects the new sample data - that will include escaping aditional &, see #14 (comment).

394 has now been merged, what needs doing to this?

@gregcorbett

gregcorbett commented Feb 7, 2023

Copy link
Copy Markdown
Member

For each of the pages under api/read/, can you update the example API output so it is a copy/paste from the output of the relevent API endpoint on an instance loaded with the sample data?

It will be sufficent to only include one result in the example API output, i.e. for get_user it will be sufficent to only have one EGEE_USER ID block.

Some endpoints wont have data populated by the sample data, such as get_cert_status_changes. I think for now it's good enough to leave the exmaple API output as is, but note which endpoints this affects.

@rowan04

rowan04 commented Feb 21, 2023

Copy link
Copy Markdown
Contributor Author

more ampersands that need escaping :/

@rowan04

rowan04 commented Feb 21, 2023

Copy link
Copy Markdown
Contributor Author

more ampersands that need escaping :/

done

@rowan04 rowan04 changed the title Update example READ API output GT-123 Update example READ API output Feb 21, 2023
@gregcorbett gregcorbett self-assigned this Feb 27, 2023
gregcorbett
gregcorbett reviewed Mar 1, 2023
View reviewed changes
Comment thread api/read/get_cert_status_changes/index.md Outdated
gregcorbett
gregcorbett reviewed Mar 1, 2023
View reviewed changes
Comment thread api/read/get_service_types/index.md
gregcorbett
gregcorbett requested changes Mar 1, 2023
View reviewed changes

@gregcorbett gregcorbett left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments.

@gregcorbett

gregcorbett commented Mar 1, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

LGTM, can you squash the new commit into the one that introduced your DN to api/read/get_cert_status_changes/index.md (I think it's this commit: d625ccd)

@rowan04 rowan04 force-pushed the 12-update-example-read-api-output branch from e034525 to f49f6d4 Compare March 1, 2023 12:18
@rowan04

rowan04 commented Mar 1, 2023

Copy link
Copy Markdown
Contributor Author

LGTM, can you squash the new commit into the one that introduced your DN to api/read/get_cert_status_changes/index.md (I think it's this commit: d625ccd)

done

@gregcorbett

gregcorbett commented Mar 1, 2023

Copy link
Copy Markdown
Member

Awesome, thanks 😄

rowan04 added 6 commits March 1, 2023 13:18
@rowan04 @gregcorbett
Update the example READ API output for get_cert's and get_downtime's …
f1d1b0b 
…files
@rowan04 @gregcorbett
Update example READ API output for get_user, get_ngi, get_project_con…
facd7ad 
…tacts and get_roc's
@rowan04 @gregcorbett
Update example read api output for get_site's and get_service's
9816fe2
@rowan04 @gregcorbett
Add code to escape ampersands
fb0d9e1 
- add amp; after two ampersands to escape them
@rowan04 @gregcorbett
Update example READ API output to ensure it reflects the newly update…
b80b830 
…d sample data

- each example api output is now a copy paste from the output of the relevant API endpoint on an instance loaded with the newly updated sample data
- only one-two results included in the example output as that is all that is necessary to understand the output
- some endpoints don't have data populated by the sample data, like get_downtime
@rowan04 @gregcorbett
Adds code to escape more ampersands
3c7c172 
- adds amp; after ampersands to escape them
@gregcorbett gregcorbett force-pushed the 12-update-example-read-api-output branch from f49f6d4 to 3c7c172 Compare March 1, 2023 13:18
@gregcorbett gregcorbett merged commit 514e600 into main Mar 1, 2023
@rowan04 rowan04 deleted the 12-update-example-read-api-output branch March 1, 2023 13:20
@rowan04 rowan04 mentioned this pull request Oct 2, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tofu-rocketry tofu-rocketry tofu-rocketry left review comments

@gregcorbett gregcorbett gregcorbett approved these changes

Assignees

@gregcorbett gregcorbett

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update example READ API output

3 participants

@rowan04 @gregcorbett @tofu-rocketry