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.

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

Define and document process for adopting AIPs in other orgs #98

Open
jgeewax opened this issue May 13, 2019 · 8 comments
Open

Define and document process for adopting AIPs in other orgs #98

jgeewax opened this issue May 13, 2019 · 8 comments
Labels
site: feature Website feature requests

Comments

@jgeewax
Copy link
Contributor

jgeewax commented May 13, 2019

The current thinking is to have a separate GitHub repository that is forkable and can redirect for everything that is not aip-9xxx and serve the 9xxx AIPs directly from the repo

@jgeewax jgeewax added the site: feature Website feature requests label May 13, 2019
@rhamiltonsf
Copy link
Contributor

I've been thinking a lot about this, and have some ideas that don't feel fully fleshed out, but would like to contribute here for brainstorming purposes.

TL;DR I think there is an opportunity here to define a AIP Specification that would result custom AIPs to be comparable to one another and extensible. I propose an example "spec" using the existing AIP definitions. However, I think this is a long term goal, and in the short term we should focus on implementing a hollow AIP implementation that allows adopters to populate with their own AIPs.

I think one of the advantages of AIP adoption across companies would be to enable AIP consumers to take two different AIP implementations and compare them side by side. This would be more easily implemented if the AIP standard defined AIP number/urls/ids for cross cutting concerns across API standards. For example, if I went to google.aip.dev/xyz to read Google's standard for "foo", then I would know that going to acme.aip.dev/xyz is going to contain Acme's standards for "foo".

This would require some level of normalization of the AIPs, as there are a few AIPs that appear to be very specific edge cases for Google.

The rough idea here would be to implement something like the following:

AIP Specification

These AIPs would exist above the currently existing Meta AIPs. They would define an overarching AIP spec that would apply to all AIP implementations. This would define the finalized version of what is being proposed here, specifically under the Guidance section.

Meta AIPs

Similar to the currently implemented AIPs, except less Googley. These would be implementation specific AIPs that define the governance of the AIPs for that organization. A default would be defined for each -- which would also be the actual AIP used by aip.dev -- however it is expected that organizations would fill in a few blanks or amend according to their needs.

Example:

  • Guidelines: Defines AIP usage, best practices, extensibility, etc.
  • Stakeholders: Defines stakeholders, review policy, how to submit AIPs, etc.
  • Workflow: Lists the states of AIPs and their meanings.
  • Style Guide
  • Contributing
  • FAQ

Guidance AIPs

Using the language as it exists today, Guidance AIPs would be the actual implementation of the AIPs and would be where the value resides.

The challenge with standardizing the Guidance APIs is identifying what is a cross cutting concern for API developers, or even cross cutting concerns for those who define the standards.

Below I've taken a stab at categorizing what I think would be the cross cutting concerns that are portrayed in aip.dev. I'm providing this more to attempt to get the point across and am not suggesting that this is the best starting point:

Guidance

  • General: AIPs that define the organizations API philosophy rather than rules that can be enforced or validated by a linter.
    • Design Philosophy: i.e. Resource oriented design
    • Change Management: How to maintain backwards compatibility, deprecation, etc.
    • Versioning: May or may not belong in change management?
    • API Lifecycle: Replacement for stability levels.
    • Documentation
    • Bad API Precedent: An interesting existing AIP, that I think is something all AIP implementers are going to need to consider and address.
  • Resource:
    • Names
    • Types
    • Caching: Maybe? Attempting to normalize on Freshness Validation and Expiration
    • Singleton: May or may not be an edge case.
    • Unreachable
  • Fields:
    • Names
    • Types:
      • Quantities
      • Enumerations
      • Time and Duration
      • Standardized Codes
  • Methods This is an especially interesting section if we consider that AIPs are not specific to one API Protocol.
    • Retrieval:
      • Single
      • Collection
    • Update:
      • Single
      • Collection
    • Delete:
      • Single
      • Collection
    • Custom Methods
  • Messaging:
    • Requests: Define format, identification, etc.
    • Responses: General format, identification, etc
      • Errors
      • Pagination
      • Partial

Additional Considerations

  • There are likely additional common concerns with each of the bullet points above. For example, some common considerations when defining Field Names are what case to use, what words are reserved, what characters to avoid, etc. These could be part of the AIP specification.

  • Each leaf in the above tree will represent an AIP. However, it seems likely that some organizations may have further addendums to make to a leaf that may result in an additional AIP. For example, if the Google AIPs were redefined in the above approach, would the States AIP be a a leaf of Enumeration? Or a sibling? Or just be defined as a custom header under the Enumeration AIP? The real question to answer regarding such a situation is, which approach would allow custom AIPs (not part of the AIP Specification) be extensible in and of themselves and allow for the greatest comparison between the Spec'ed AIPs in the implementation against those of other implementations.

  • Although these might be standard cross cutting concerns, API definers or AIP implementers may not want to define all of these right away, or ever. And if there is not default implementation of them, they may not want an empty page. There should be a "NA" status that removes the page from the nav bar and search results and displays an NA page if implemented.

  • Here is a list of AIPs that I thought were very specific to Google. These could go in custom categories under any of the above nodes: Transcoding, Long Running Operations, Reading Across Collections, Resource Revisions?, File and Directory Structure, retries for gRPC clients, field behavior documentation, beta blocking changes, Unicode

What I think is working with the above proposal is that it would allow AIPs to be normalized across organizational implementations. I would like to see if it could be normalized across protocols, but I am not entirely convinced that is possible. However there might be additional AIP Specifications specific to the protocol (HTTP vs gRPC) or standard (REST vs RPC) being used.

The Point

All this said, I believe there is an opportunity here to enable side by side comparisons of API standards using a common API definition standard (AIPs). However I don't think the current AIP numbering system would facilitate that. You might be able to say range 150-160 are reserved for Resource definitions, but what happens if a AIP implementor has 20 different custom AIPs they want for Resources. I think a hierarchical approach might be best here, although I like the idea of AIPs (for their name sake) having specific numbers/ids that identify them.

I think there might be an opportunity here to define an AIP specification here that governs how these standards can be defined.

However, all this said, I think the best place to start is with a de-Googled AIP infrastructure that has no AIPs in it and allow adopters to fork and populate their own AIPs using the patterns you have provided.

rhamiltonsf added a commit to rhamiltonsf/aip that referenced this issue Jul 28, 2020
commit 52b088dc0efde35e8034d67128140ae8bf940aca
Merge: 1d4ec14 62210be
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Jul 27 15:19:26 2020 -0600

    Merge pull request aip-dev#104 from API-Stewardship/feature/90

    Removing Google and Protobuff specific language out of the glossary…

commit 62210be2e866586212d5176d79931a90743b4789
Merge: a0e45f4 1682ef0
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Jul 27 15:17:37 2020 -0600

    Merge branch 'feature/90' of git.soma.salesforce.com:API-Stewardship/sf.aip.dev into feature/90

commit a0e45f4699910bdf5cb2c8b44abe248551383577
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Jul 27 15:16:20 2020 -0600

    removing network because it was confusing. Altering Client and Consumer.

commit 1d4ec14652b758078990199f9e9d621b28bc0a23
Merge: 03a69d5 926278f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Jul 27 12:25:25 2020 -0600

    Merge pull request aip-dev#105 from API-Stewardship/pre-release

    Final Updates before release.

commit 03a69d524c893124432d9a6aae5de8a5fba589ba
Merge: 471752f 10f8751
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Jul 27 12:21:59 2020 -0600

    Merge pull request aip-dev#98 from API-Stewardship/codeowners

    initial commit to verify code ownership

commit 1682ef097b63d6d554709a9f135cff58ba46f534
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 17:41:05 2020 -0600

    Update aip/0009.md

    Co-Authored-By: Rob Spremulli <rspremulli@salesforce.com>

commit 926278f2c54a43ea2d96112bdfcfc5c707ef8ad7
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 17:33:33 2020 -0600

    Final Updates before release. Changed state of AIPs to approved where appropriate. Fixed the structure of a couple of AIPs to match the Style Guide. Fixed links that were not working, and fixed RFC and AIP names to be consistent with the style guide. Adding guidance on AIP extensions. Removed margin section from style guide

commit 471752fcbd04f4205a285b340c2cd4b59c006015
Merge: d32cc8d 4f86f82
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:16:55 2020 -0600

    Merge pull request aip-dev#74 from API-Stewardship/feature/11

    Adding public comment

commit d32cc8db3fe093ba9ef52d5d50229327e559bed1
Merge: a2a0237 dd5053a
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:16:37 2020 -0600

    Merge pull request aip-dev#79 from API-Stewardship/feature/17

    33: Errors

commit a2a02376ee2a5c4aeed2daff3bd7ccfbbee18ed0
Merge: 40fa09c 61de452
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:16:19 2020 -0600

    Merge pull request aip-dev#81 from API-Stewardship/feature/16

    16: Backwards compatibility

commit 40fa09cfb0ae2436c7282f47cd9d82f54568f8b0
Merge: 2db1e05 b651aad
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:16:00 2020 -0600

    Merge pull request aip-dev#83 from API-Stewardship/feature/31

    31: Request

commit 2db1e054b7ba0f35f5bbcb21812b75e17f957835
Merge: ff12c42 49ae627
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:15:34 2020 -0600

    Merge pull request aip-dev#84 from API-Stewardship/feature/30

    30: Messaging

commit ff12c420e87adcd3338777f9b0515785f8f95153
Merge: 453226d a9f1c22
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:15:15 2020 -0600

    Merge pull request aip-dev#86 from API-Stewardship/feature/22

    Feature/22

commit 453226dbb42032fe84cc36b001bf165608814a04
Merge: 2d8d00e 3d8b46f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:13:00 2020 -0600

    Merge pull request aip-dev#100 from API-Stewardship/doc-edit/32

    doc review updates

commit 3d8b46f46c7b4ef6089f1895a0e911d6b3fabdea
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 15:12:42 2020 -0600

    Update aip/5200.md

commit e7e52017946682b2de45f8f6fd5a899765da01e4
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 14:30:25 2020 -0600

    Removing Google and Protobuff specific language out of the teglossary and alphebatized it

commit 2d8d00e9f12c1f0e06f2c00a7f4535202804c27f
Merge: 3b8b212 1a8e8fe
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 14:14:33 2020 -0600

    Merge pull request aip-dev#73 from API-Stewardship/feature/26

    AIP: Update

commit 3b8b212a8801b1fde0271fcd15811323a4c5b360
Merge: eb97966 d1a7d84
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 14:12:21 2020 -0600

    Merge pull request aip-dev#47 from API-Stewardship/edit/4400

    Initial writeup of delete

commit d1a7d84e9c0bca8c13365f7eda9a75867c69c01f
Merge: 4ba1036 eb97966
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 14:11:45 2020 -0600

    Merge branch 'master' into edit/4400

commit 1a8e8fef966eae7f53160e35cdbb3e368af45a92
Merge: 74d459c eb97966
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 14:05:57 2020 -0600

    Merge branch 'master' into feature/26

commit 4f86f8256c3defc1b1b44f9bc122f4fce838530c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 14:01:24 2020 -0600

    Update aip/0004.md

commit eb979669dcdf469aec7318329c5dfcf0de605406
Merge: 45ecdd1 ba8038c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 13:59:53 2020 -0600

    Merge pull request aip-dev#77 from API-Stewardship/feature/25

    Adding GET and LIST AIPs

commit 74d459c3a822ef798d34e76ee237db194a7bcaf0
Merge: 76d5ada 45ecdd1
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 13:02:30 2020 -0600

    Merge branch 'master' into feature/26

commit 45ecdd1003546f065830c0870039a756e72a5088
Merge: f20c3f4 fa713f4
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 12:55:10 2020 -0600

    Merge pull request aip-dev#76 from API-Stewardship/feature/28

    re-writing create to be formated consistent with AIPs

commit ba8038c78261cec987c4b2d79ed7d2f622537b51
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 24 10:48:22 2020 -0700

    doc review

commit ba8baf5bb071cfc326510e207e758aedd0477287
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 24 10:40:03 2020 -0700

    doc review updates

commit f20c3f435be4515dc46394848599bd8677a0da2e
Merge: 18243ee 395758b
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 11:23:00 2020 -0600

    Merge pull request aip-dev#97 from API-Stewardship/doc-edit/23

    doc edits for 0140 and 3000 aip-dev#23

commit 395758b6ac769b9e3f0909f12a5ebcbe62bb5117
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 11:22:52 2020 -0600

    Update aip/0140.md

commit 4ba10368626209f6977bea5e1aba234b45b11232
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 24 10:15:30 2020 -0700

    doc review for delete

commit fa713f43537f8ae8fe5f4a74ca7d43bdedce7bd9
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 24 09:52:10 2020 -0700

    doc updates to aip-dev#28

commit 18243ee7eb4365e33b1969a9bcaaa071fe2fc124
Merge: bf9ca42 cf7f939
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 24 09:20:39 2020 -0700

    Merge pull request aip-dev#88 from API-Stewardship/doc-edit/18

    Doc review for updates to 1300 aip-dev#18

commit cf7f9392127ee34bccc804e00889cd893eed3486
Merge: 665d7c0 bf9ca42
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 24 08:58:44 2020 -0600

    Merge branch 'master' into doc-edit/18

commit a3e005c38210eddff4c48d4552bddddb6cda74b0
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 23 22:58:36 2020 -0600

    removing reference to API Stewardship Committee

commit 1a2a504bcc4bda7b053cac269913a39c24fab188
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 23 21:09:29 2020 -0600

    rewriting the whole paragraph to make it easier to read, and better clarify the intended points.

commit 63e4311ff2badbb8285d68e986a523e28b2b8b06
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 23 20:53:43 2020 -0600

    updating working around breaking changes to encourage particiation from early adopters during public comment and also to provide some reasurance as to what a non-breaking change consists of.

commit 6ab59cd937f18a2776ea08c60792e74b1145b4c0
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 23 20:06:32 2020 -0600

    minor word changes to avoid confusion.

commit 5b89f07afd62de624a41801edca36a3e50cfce6a
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu Jul 23 20:34:35 2020 -0400

    review comments

commit 10f87511e1fa14eca734a9b0f2c2a09145e9ed5c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jul 19 16:33:46 2020 -0600

    initial commit to verify code ownership

commit bf9ca42449e5899164e0c78fed5dbdf91b41120f
Merge: a17adfa 35074cb
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jul 19 15:24:03 2020 -0600

    Merge pull request aip-dev#72 from API-Stewardship/edit/5400

    Edit/5400

commit a17adfa8a6c4393d26d561b703471fbac61c0145
Merge: 2cda048 5cdb107
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Jul 17 10:25:03 2020 -0600

    Merge pull request aip-dev#80 from API-Stewardship/feature/32

    32: Formatting Response AIP

commit 1e7a3d6538bd0b57eb31fb1ec2357e7f8c0bf463
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Jul 16 20:51:48 2020 -0700

    doc edits to 0131 and 0132

commit c44ddb78f85ce6b3e2b800ab0e0c46d5fef2bcd8
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Jul 16 20:33:28 2020 -0700

    doc edits for 0140 and 3000

commit 76d5ada5eda50de9c36dbd73796223bcf4ebd62a
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 16 13:37:25 2020 -0600

    removing guidance regarding updating array and object properties in a resource.

commit 2cda048cc73f0aa72ee10e98365cddc625b89ba1
Merge: 32b7ceb f01d81f
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Jul 16 09:52:59 2020 -0700

    Merge pull request aip-dev#75 from API-Stewardship/feature/7

    Updating contributing based on feedback from Kelsey

commit 35074cb619b1844c4f687b4751f821bc4d81de0b
Merge: 8900420 32b7ceb
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 16 01:16:01 2020 -0600

    merging

commit 08b97d59fa211fe53bc8550ff6feca15c37f6634
Merge: fb78e9a eb0fef8
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 16 01:13:06 2020 -0600

    Merge branch 'feature/26' of git.soma.salesforce.com:API-Stewardship/sf.aip.dev into feature/26

commit fb78e9af1a877d4e2d6a1e076e99d4f8da8e58bc
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 16 01:12:27 2020 -0600

    Had wrong RFC number for JSON Merge PATCH, and the completely wrong RFC linked. Fixed

commit eb0fef8d4f9dce733b1f45faf27f64a070f943ec
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 16 00:48:46 2020 -0600

    Update aip/0134.md

commit 838c6291fd1dfbcd18ba40f96c2e9f6a75f19fcf
Merge: 373230a 32b7ceb
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 16 00:01:27 2020 -0600

    Merge branch 'master' into feature/11

commit f01d81fdf3db805633e6aa9c3d5e6597eb185a42
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 23:41:27 2020 -0600

    changing contact to Chatter

commit 7e3560e27945a81b19ff9c69d0721c249933a076
Merge: 6b1c8f2 57bdd72
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 23:14:50 2020 -0600

    Merge branch 'feature/26' of git.soma.salesforce.com:API-Stewardship/sf.aip.dev into feature/28

commit 6b1c8f2e030fa0507fbf29f361e7ab4c7095af2c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:54:45 2020 -0600

    Adding link to update

commit 57bdd721b450ca1d995cff8fd6a1452dd913c09c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:51:47 2020 -0600

    Update aip/0134.md

commit 3eaf6c7da73a43f48c0ac34018e3b81361aae9fa
Merge: d4585ee 32b7ceb
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:31:40 2020 -0600

    Merge branch 'master' into feature/25

commit d4585ee6fd1b6c857f22eb9bae2984979ef94cf0
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:25:38 2020 -0600

    Update aip/0132.md

    Co-Authored-By: Ray Polk <rpolk@salesforce.com>

commit 84c1a67e32c2195b7a231cb53942e5d333c5c55e
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:21:03 2020 -0600

    Update aip/2000.md

    Co-Authored-By: Ray Polk <rpolk@salesforce.com>

commit e318ca7eb5a317a3c6924fd121797d75bcbb3486
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:17:21 2020 -0600

    Update aip/0131.md

commit 64b8f466f3a1607b56eb898a285f6c1274e267c9
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:12:26 2020 -0600

    Update aip/0131.md

    Co-Authored-By: Ray Polk <rpolk@salesforce.com>

commit 65a7eaf50230f851c3edb5d696cd6017b007ee5d
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 22:10:34 2020 -0600

    Update aip/0131.md

    Co-Authored-By: Ray Polk <rpolk@salesforce.com>

commit 61de4525e2988b26efddca59534e3a61fa96d88b
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 21:34:52 2020 -0600

    Update aip/0180.md

commit 2842c07e755cb29b488967282674ba109b62f9e1
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 21:34:26 2020 -0600

    Update aip/0180.md

commit 32b7ceb61ba033dab74ee742c8d01c029f19b2b1
Merge: 70dbc47 816f383
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jul 15 21:29:27 2020 -0600

    Merge pull request aip-dev#89 from API-Stewardship/doc-edit/19-20-21

    doc review edits for issues aip-dev#19-21

commit 70dbc47d2b7032db82a61ad1f9dc4cdaea04bdf9
Merge: 35678f6 e30000e
Author: Ray Polk <rpolk@salesforce.com>
Date:   Tue Jul 14 16:49:34 2020 -0600

    Merge pull request aip-dev#82 from API-Stewardship/feature/23

    23: updating Field Names AIP

commit 35678f6582a7fc1ec0f9443bdab55fe08fecbc9e
Merge: f4c32e4 c046c98
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 16:47:56 2020 -0700

    Merge pull request aip-dev#85 from API-Stewardship/feature/9

    9: updating FAQ

commit 816f383d9a74793c3da771c1497e4c7b6886f9b0
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 16:43:42 2020 -0700

    Update aip/0009.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 57dec795c8d529abcae80401a5c0154814d27b2c
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 16:43:32 2020 -0700

    Update aip/0003.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit c046c98604ecccf2f64fc8c05f1866b1e69b897f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 10 16:58:22 2020 -0600

    Update aip/faq.md

    Co-Authored-By: Kelsey Lambert <kelsey.lambert@salesforce.com>

commit 97781ba34a9d7315fd04b0aefeedf03c30abba31
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 10 16:53:39 2020 -0600

    Update CONTRIBUTING.md

    Co-Authored-By: Kelsey Lambert <kelsey.lambert@salesforce.com>

commit 0561cf0a2cf54e8228d921cb107d5475953700e5
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 13:18:02 2020 -0700

    doc review edits

commit 665d7c0a6937032094db0bd398674d4215909e94
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 12:11:34 2020 -0700

    Update 1300.md

commit f4c32e4eac67c621db11fd4366af158dcc7962ad
Merge: a2ade6f eafcc07
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 10 12:36:11 2020 -0600

    Merge pull request aip-dev#87 from API-Stewardship/edit/54-doc-review

    Edit/54 doc review

commit eafcc07ccb59835a8dff6c1122d5aa4fa64677c3
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 11:35:12 2020 -0700

    final edits

commit e6eba3e543a39078b76e2ee384c0b135027bba01
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 10:54:12 2020 -0700

    Update aip/commerce-cloud/82100.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit f92e147d47d0953b90e1366d5c913ead29136252
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 10:54:04 2020 -0700

    Update aip/2000.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 3b4389fa0013d8079fae66abb37a699012cebc3d
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 10:53:40 2020 -0700

    Update aip/commerce-cloud/82100.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 8e09f4b58c8154284289b0d73b58037336cc08d9
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 10:53:33 2020 -0700

    Update aip/0122.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 337a8ad87b6821afdabe2be0fe9e0161f0b2c90c
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 10:51:58 2020 -0700

    Update aip/0122.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 8f05eba42b61e281fd1ebb720a2487d5e5671956
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 10:51:52 2020 -0700

    Update aip/0122.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit fc020113c13f57cadf85a077e309014c48ae93ea
Merge: 4072cbf a2ade6f
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 09:28:01 2020 -0700

    Merge branch 'master' into edit/54-doc-review

commit 4072cbf499416f780a7b74afb6ccbf2473156105
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Fri Jul 10 09:27:04 2020 -0700

    doc review for PR 54

commit c054f79b541c73388df6f46101c1b13ff3a42cf5
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 9 23:31:44 2020 -0600

    adding supporting image

commit a9f1c221d5afc429608cdf9e0f3c16325aca2a94
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 9 23:14:28 2020 -0600

    adding images. Also adding long running operations

commit 892ae745a00ffc1a7dd761ca54d5f6327a3da960
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 18:07:00 2020 -0600

    9: updating FAQ

commit b651aadf8483d9ed0d8cbbb202cc9ffb20f1b603
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 16:03:08 2020 -0600

    Helps if I save before committing...

commit 49ae6272ecd2c0c7e88a811a514e9ec7faa26e9d
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 16:00:52 2020 -0600

    It helps if I save before committing...

commit 4c218bd2093ea82fe591d3bb2ec7f2666eb9f65b
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 15:58:02 2020 -0600

    30: Fixing Messaging (AIP-5000) and add Long-running operations (AIP-151)

commit be68c33ffb43ea64bf723a1b43692ca072672863
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 15:55:41 2020 -0600

    Re-adding Request AIP-5100 after reviewing Messaging (AIP-5000) and discovering content that I felt better fits in Requests

commit f2cde8412b7281cf19afb8a31fb16071bbbd52cb
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 14:51:17 2020 -0600

    removing this AIP as I could not find any guidance for it in the 1.1 spec

commit 5cdb107d64a5137b7f4409346a6409ce797e623e
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 14:49:34 2020 -0600

    updating requests AIP to have rate limiting

commit e30000ee38ca1124e51881e171cec756a4d9c52b
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 13:44:23 2020 -0600

    update 3000 to reviewing

commit fdeadfb645b39df80c004e693a0db7b1b306e47f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 13:25:51 2020 -0600

    23: updating Field Names AIP

commit 74cdfe48952cd64c09cf9af686838cd89f260cb3
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 12:49:59 2020 -0600

    starting on the images

commit 1cfb49fc357deaa9dad7a255547f72b931c1df72
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 12:29:07 2020 -0600

    16: Backwards compatibility

commit 5523de69edb73511936988a34f87149a21a5d7b9
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 12:05:24 2020 -0600

    32: Formatting Response AIP

commit dd5053a1b65ffc9015f1186ed3b39fc2e9d9ec09
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Jul 4 11:52:31 2020 -0600

    17: Errors

commit f71a7be7adedacff95963c4ab78fe8b83196f5e4
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jul 3 23:49:04 2020 -0600

    Adding GET and LIST AIPs

commit af7c72790230111513e8427116870e62090c7e64
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 21:32:40 2020 -0600

    Update aip/4300.md

commit 56aec6ab33b49828254f2d387f0400e7f3a7ef4f
Merge: 3db989b a2ade6f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 20:58:23 2020 -0600

    Merge branch 'master' into feature/7

commit 6250b528edf99833c7d2c978b0caa4ef86b1e91e
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 20:53:53 2020 -0600

    Apparently some of my previous updates were not added in a previous commit >_<

commit 644eee6b69f99870781e3791ede4498f85daec3f
Merge: f26da92 a2ade6f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 19:34:20 2020 -0600

    Merge branch 'master' into feature/26

commit a2ade6fdba45f7a464d8b8abb87b974bdfd07e9d
Merge: 5de17b3 6a68437
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 18:49:39 2020 -0600

    Merge pull request aip-dev#69 from API-Stewardship/feature/21

    Update resource types

commit 6a68437d010259b509b5fe0a20c53a39c2cb84dc
Merge: 0877248 5de17b3
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 18:49:11 2020 -0600

    Merge branch 'master' into feature/21

commit 5de17b3f069adba78ed7478b67dd99a2879ea881
Merge: be4a6c8 2d21522
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jul 2 18:41:03 2020 -0600

    Merge pull request aip-dev#68 from API-Stewardship/feature/67

    Updating AIP indexes to beter align with Google AIP indexes in antici…

commit be4a6c869a6a527d1b6fc24f187081b0b23a8279
Merge: b4942ef 1bffbdb
Author: Victor Romero Carrasco <vromerocarrasco@salesforce.com>
Date:   Mon Jun 29 16:22:03 2020 +0200

    Merge pull request aip-dev#70 from API-Stewardship/edit/1300

    minor edits on versioning, needs more work on 1.2 aip-dev#18

commit f26da9220b92b831a523834e8c97fa9f3546548e
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 25 23:03:21 2020 -0600

    adding information about concurrent updates found in the create AIP and reformatting the AIP to better match the AIP structure for Update.

commit b1b039a300499033108775670d59aa484d4f1b59
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 25 22:05:38 2020 -0600

    re-writing create to be formated consistent with AIPs

commit 3db989bedff19831b6a267b7aff740e7d9496dbc
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 25 16:19:30 2020 -0600

    Updating contributing based on feedback from Kelsey

commit 373230a3a8aeeafc73c2c3b4e0948116d83c45a5
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 25 15:41:52 2020 -0600

    updating approved state to account for the previous state to have been comment for 60 days

commit 898e65147dba26308e1c93b56c6af171edf2a42e
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 25 15:36:40 2020 -0600

    Adding public comment

commit ac00ef60d34e85b9e829743c962d5101126e6faf
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 25 14:47:51 2020 -0600

    Providing content to Update AIP. May not be the final content, but should be brought to the API Stewardship Committee

commit 89004201df7e6e8cb2e56185ef7387a5afc0c0b9
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu Jun 25 13:07:12 2020 -0700

    Removed a modified file from pull request

commit 5f0ed1327f3671d22ade71bcd828ffade86d0495
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu Jun 25 13:04:29 2020 -0700

    updating state of pagination to approved aip-dev#34

commit 1bffbdb87117cabca202d27e3a15e186638c9abe
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu Jun 25 12:46:27 2020 -0700

    minor edits on versioning, needs more work on 1.2 aip-dev#18

commit 8dabd19d911ea66ac2c5d506439e691adb8761eb
Merge: 985d908 b4942ef
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:57:50 2020 -0600

    Merge branch 'master' into feature/26

commit 08772488cbf2dae3cbb8d8adf4fb25b38ae2e51c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:54:19 2020 -0600

    removing uneeded links, and adding an example a note that I missed

commit 9a5d2d385f9168df0c22fd8e9ab9755b91be55d9
Merge: 7efb0e6 79f1e17
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:45:25 2020 -0600

    fixing merge conflicts

commit 7efb0e62e258ed62bd6572df1556be099d6eafca
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:44:20 2020 -0600

    Cleaning up merge

commit 79f1e17735183df0d596c89e2272e0f98a636eef
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:43:22 2020 -0600

    Update aip/4500.md

commit 702004ff09ab03fcb6b1a3d6a40bb2f9e0ba8c3c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:43:09 2020 -0600

    Update aip/4500.md

commit f661340fc3be123aa7f3977116c620285bc554f4
Merge: 68a4fea b4942ef
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 20:34:44 2020 -0600

    Decided to remove resource types, as all the content in this AIP has already been implemented in another AIP
    and it's not clear how resource types fits in anything other than Google's AIPs

commit 68a4fea8d588dc774f81ab2f698747d0b1a272fc
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 18:07:42 2020 -0600

    Updating resource types.

commit 2d215221fd2e87e47ed9db79b07d281db0990059
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Jun 14 16:48:47 2020 -0600

    Updating AIP indexes to beter align with Google AIP indexes in anticipation of needing to be more aligned in order to properly extend.

commit b4942ef88b9e52bf77a08dde5cbd8d50e47e5c61
Merge: 8b9848e a8f78ad
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jun 4 14:44:18 2020 -0600

    Merge pull request aip-dev#66 from jared-pearson/master

    Remove Pardot from AIP

commit a8f78adbe0bfce51dbd1aa2b62dcc66aa1e8e20c
Author: Jared Pearson <jared.pearson@salesforce.com>
Date:   Thu Jun 4 07:01:55 2020 -0700

    Remove Pardot from AIP

commit 8b9848e676784deb4443a597322630cef059f15e
Merge: a24fb20 18107c0
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Jun 1 09:29:16 2020 -0600

    Merge pull request aip-dev#65 from API-Stewardship/feature/54

    Feature/54

commit 18107c02dfc8702e512a7dc4dd1a208f66628e8c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun May 31 19:32:16 2020 -0600

    updating 3, 4, and 5 to have the correct scopes

commit 6964b4eb78ddff946fbcc37525618d5c853fa399
Merge: 0f67f2e 2402888
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 22:36:13 2020 -0600

    Merge branch 'feature/54' of git.soma.salesforce.com:API-Stewardship/sf.aip.dev into feature/54

commit 0f67f2ecb6c0f6d7a81e557ea6c803253dd373a2
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 22:35:20 2020 -0600

    updating Mercury standards around resources to align with the AIP numbering conventions

commit 24028886d69fe06ed8c501ca42c37768e3853f49
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 22:02:21 2020 -0600

    Update aip/pardot/32000.md

commit f4b9e1786de5369f1b5be2928e59053d3f780c61
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 21:52:29 2020 -0600

    adding resource aips

commit e1de593d819871bd8149bf466ed03944e180ec0e
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 21:44:58 2020 -0600

    removing code I didn't need

commit c3c8a3dccd54024fcc077bfff4156be8d9c73dc2
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 21:42:48 2020 -0600

    Adding Pardot standards. Adding section to the navigation bar for organization level AIP navigation.

commit f02360ec806049ceed85c7df10b17c9c11b57918
Merge: 40353af a24fb20
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 21:30:25 2020 -0600

    Merge branch 'master' into feature/54

commit 40353afdc17d853445b8920125648555fb830947
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 21:27:45 2020 -0600

    adding pardot

commit a24fb20fd54d1b4a155663201a36444f834db044
Merge: 68ec640 3d0cebe
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 29 21:26:26 2020 -0600

    Merge pull request aip-dev#62 from API-Stewardship/feature/mercury

    Feature/mercury

commit 3d0cebe06b5e1f7df656ce425357de5e8c2f95dd
Author: Robert Spremulli <rspremulli@salesforce.com>
Date:   Fri May 29 17:38:00 2020 -0400

    Renaming to 8900 range

commit bd21d4e0e04917ab32378a800535f4c0a5a34ca5
Author: Robert Spremulli <rspremulli@salesforce.com>
Date:   Fri May 29 17:10:53 2020 -0400

    Moving to sub folder and changing contents

commit f1d500cafca390ab400e6a6eba7bb9d85c794252
Merge: 2ac448a 1a20022
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 22 09:24:38 2020 -0600

    Merge pull request aip-dev#38 from API-Stewardship/feature/11

    Feature/11

commit 68ec640731623e10f42d95233ced42cb7ddd1e1c
Merge: 2ac448a 1a20022
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 22 09:24:38 2020 -0600

    Merge pull request aip-dev#38 from API-Stewardship/feature/11

    Feature/11

commit 1a200229de12bdb17590cc00368f6285be8b327e
Merge: 2c6f2cd 2ac448a
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 22 09:24:15 2020 -0600

    merging into master

commit 2ac448a537407611dcfd7daf3968adef2e3dd66c
Merge: 4b5709e 8a3b3d6
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri May 22 09:19:50 2020 -0600

    Merge pull request aip-dev#35 from API-Stewardship/feature/15

    aip-dev#15 I had previously rewritten this AIP from the

commit 82aa13ee42746f5114dda628d2fcf62815abbb9d
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:43:49 2020 -0400

    Create 82300.md

commit fc921174eb1648543da9c9f66a7d50c772115e0e
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:42:51 2020 -0400

    Create 82280.md

commit 350f7ccbe2b21b1a40dfe21401819a33eb9004c4
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:41:08 2020 -0400

    Create 82270.md

commit 96c967a1309d4ac839b5f19d0d50e6fbd921adae
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:39:58 2020 -0400

    Create 82260.md

commit 0924d739b9fcc9fd402e55b4be1651d7a42bba54
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:39:02 2020 -0400

    Create 82250.md

commit 7f82fb878f3f0708172ecef70b665923c625722f
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:37:45 2020 -0400

    Create 82240.md

commit a6782d60581e9e568983f66b54b66b6cc18be07e
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:34:38 2020 -0400

    Create 82230.md

commit 4cd7e42e558f22bb23606ee21090dc83baa8ffdf
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:22:56 2020 -0400

    Create 82220.md

commit ddcd2aede8356242966aa587c2e770bab980a8a2
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:21:33 2020 -0400

    Create 82210.md

commit cae0c9299bc9d586307f8b7a98ce4eaab2e5b0a7
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:18:04 2020 -0400

    Create 82200.md

commit 0bbfa57e491285c33fa86f688ec582cff968820b
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:08:29 2020 -0400

    Create 82100.md

commit 0f3d8aefb57d38bcc140ac5f042be5a5f82b2406
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 22:01:10 2020 -0400

    Update 82000.md

commit 52be915fe6871deb9d6d9831fcd928a61617e2cf
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 21 21:48:54 2020 -0400

    Create 81000.md

commit 4b5709ee605b5cc9d7b0121572a5561dae592f4b
Merge: 6934609 9e84234
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Fri May 15 11:30:05 2020 -0700

    Merge pull request aip-dev#60 from API-Stewardship/dev/branding

    updates to aip-dev#5 incorporating Rob's changes from aip-dev#48

commit 9e84234c80df61bbaa1fa4932c8160b5932750c7
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Fri May 15 09:06:17 2020 -0700

    copying Rob's changes from aip-dev#48 to Mak's changes in aip-dev#5

commit bd949fed0d8e4a3ff415ee104fea9469c1f8d0c4
Merge: b22f3bb 6934609
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Fri May 15 08:59:13 2020 -0700

    Merge branch 'master' into dev/branding

commit 4483a7cd745f3b5da8c8424e0600bb298bfa7701
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 14 20:22:40 2020 -0400

    Create 82000.md

commit 5df598c0a31c8fc1c5822a77629f4a07c8413035
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Thu May 14 19:59:02 2020 -0400

    Create 80000.md

commit 6934609bacceca0a702b44cb642683f685b741a1
Merge: 4626055 eca3e7b
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu May 14 16:03:15 2020 -0700

    Merge pull request aip-dev#61 from API-Stewardship/edit/5400-doc-review

    documentation review of 5400

commit eca3e7b4c286333ee13f89461e6202ac61fcf69a
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu May 14 14:03:28 2020 -0700

    documentation review of 5400

commit 4626055dd3cfc3882d8d0e9c05bea0a9d8b7d12f
Merge: 92334fa f848c71
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon May 11 14:55:30 2020 -0700

    Merge pull request aip-dev#42 from API-Stewardship/edit/5400

     Update to pagination aip-dev#34

commit f848c71090d43284242ce2fb85017bd76ac91ebf
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon May 11 14:53:22 2020 -0700

    Update aip/5400.md

    LGTM

    Co-Authored-By: Rob Spremulli <rspremulli@salesforce.com>

commit 3b366c3f225e5b037a28d3741d44ec7cc0ef5460
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon May 11 14:49:35 2020 -0700

    Update aip/5400.md

    LGTM

    Co-Authored-By: Rob Spremulli <rspremulli@salesforce.com>

commit df3e304b7dabeb6d3cd5fb9dcf321fe39cc928f5
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon May 11 14:48:44 2020 -0700

    Update aip/5400.md

    LGTM

    Co-Authored-By: Rob Spremulli <rspremulli@salesforce.com>

commit 55b9adf11764a7b40a8d47496c27afed79533b77
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon May 11 14:39:23 2020 -0700

    Update 5400.md

    Pagination updated aip-dev#34

commit 6e99562324975af56132ccf747a3ef5e335ab0ac
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon May 11 14:27:11 2020 -0700

    Update 5400.md

    Updated MUST and MAY to be bolded

commit b22f3bb1cfe391d0ee524c142af861520dce57f9
Merge: 5e7d29f 92334fa
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu May 7 13:58:46 2020 -0700

    Merge branch 'master' into dev/branding

commit 5e7d29fed7dfab5cfb9ad54663d401fb7a36e401
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu May 7 13:56:31 2020 -0700

    updated additional Google references to Salesforce and took out googler names and replaced with salesforce aip-dev#5

commit 92334fad57ba9e1d5297755cc85ce5ebf0c3853d
Merge: 25b8c42 aa83a89
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu May 7 13:44:17 2020 -0700

    Merge pull request aip-dev#59 from API-Stewardship/dev/branding

    Update logo to Salesforce and update Google Analytics tag

commit aa83a89229c03af9e49be013733ec8942c2f2162
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Thu May 7 00:51:53 2020 -0700

    Update logo to Salesforce and update Google Analytics tag

commit 25b8c42ce542b2609f9a39c94a4f41afddba2fee
Merge: e3af5c6 3db2fc2
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Wed May 6 23:12:39 2020 -0700

    Merge pull request aip-dev#44 from API-Stewardship/feature/43

    Merge aip.dev into sf.aip.dev

commit 985d908f3f44c25b1c26e3c655bc83eb0506fbc5
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri May 1 09:15:20 2020 -0600

    Fixes aip-dev#26 - Initial creation of Update AIP.

commit 3db2fc2763ce08a4ccd40b17a4bf131003f8fb43
Merge: ece817b e3af5c6
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 21:10:26 2020 -0600

    fixing merge conflicts

commit ece817b22ba99ec40dff0266e50ca2d27a1e8c26
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 21:06:29 2020 -0600

    fixing typo

commit e3af5c6de4e28a4c7cc79a29bd727bd62b5d671f
Merge: ce9d708 87cae07
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:54:08 2020 -0600

    Merge pull request aip-dev#36 from API-Stewardship/feature/12

    Feature/12

commit ce9d708d6c800dde83305cb24695da67030b2024
Merge: 79c692a 4150344
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:39:04 2020 -0600

    Merge pull request aip-dev#37 from API-Stewardship/feature/7

    aip-dev#7 Updating contributing information.

commit 415034473368f72fe6e0d6459a301d1207ec311a
Merge: 3d09be9 7df5ef7
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:36:45 2020 -0600

    merging all changes and formatting them

commit 3d09be99224b07516ea19fd471870ac0e66aa848
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:31:10 2020 -0600

    fixing links that were rendering incorrectly

commit 79c692ad7ccc3faf3101447501f7e85d6dc044d6
Merge: 2721816 e5e22e4
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:13:54 2020 -0600

    Merge pull request aip-dev#39 from API-Stewardship/feature/13

    Updating Style Guide

commit e5e22e41cbf61229b25157a3818ef25dff483d19
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:13:17 2020 -0600

    formatting and changing requirments to Guidance

commit 7233aca118ff536c9f60de5a0532890c32881b03
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 30 20:10:57 2020 -0600

    storing changes

commit 5be51232947fbb12f03dc60f1068b7bf5d6d7795
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Apr 30 16:05:07 2020 -0700

    final doc review for style guide

commit ee8cacc7669b95762383f61ba43a2805325428b1
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Apr 30 15:30:10 2020 -0700

    Apply suggestions from code review

commit 8ed08c4d33fcc19e7872f5c9c6d517c393ac1048
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Apr 30 15:29:20 2020 -0700

    doc review of aip/0008.md

commit 7a02dc30da25c503a4aa3506337d3c14a304da60
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Apr 30 15:29:07 2020 -0700

    doc review of aip/0008.md

commit 2c6f2cd198dbd2faab72d5e0fe82ce793016ea64
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Thu Apr 30 15:26:47 2020 -0700

    documentation review

commit ad829f6c55daa3b643d3e6baaa1317fc4b5b0de7
Author: Ray Polk <rpolk@salesforce.com>
Date:   Thu Apr 30 12:37:04 2020 -0600

    Fixes aip-dev#21 - initial definition of various Resource Types.

commit 8ed6906e3612c2d3d7ddeca68732a5ed88d29664
Author: Ray Polk <rpolk@salesforce.com>
Date:   Thu Apr 30 11:14:05 2020 -0600

    preliminary changes

commit 7df5ef7e022c25e82153bad01a36abcab799b35e
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Wed Apr 29 16:16:17 2020 -0400

    Update CONTRIBUTING.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 8e44b42b107506ba2059b7b785341f26fbc3de97
Author: Rob Spremulli <rspremulli@salesforce.com>
Date:   Fri Apr 24 11:23:32 2020 -0400

    Initial writeup of delete

commit 3942b3e6e95e258a1b7127d409ed7b15dcbf6101
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Apr 24 09:13:44 2020 -0600

    Update CONTRIBUTING.md

commit 2721816071bdf97f4e2748aa951e6edad6125ace
Merge: 1a070d1 2146687
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Tue Apr 21 12:28:04 2020 -0600

    Merge pull request aip-dev#40 from API-Stewardship/feature/29

    Initial re-write of Custom Method section.

commit 2146687d6df5171103c496451b1d395d5d1e8c0d
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Tue Apr 21 12:17:13 2020 -0600

    Update aip/4500.md

    Co-Authored-By: Ray Polk <rpolk@salesforce.com>

commit 1a070d1f643d9d2c033608d5449a6b5709836e46
Merge: 41a547a 8264e4b
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Tue Apr 21 09:23:59 2020 -0700

    Merge pull request aip-dev#46 from API-Stewardship/dev/branding

    Dev/branding

commit b7da13309c105085eef13ec6d2a2a0f8eaa4329c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Tue Apr 21 10:00:28 2020 -0600

    Update aip/4500.md

    Co-Authored-By: Kelsey Lambert <kelsey.lambert@salesforce.com>

commit e184fb973774b0afe34094f96998ce9b851833e1
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Tue Apr 21 10:00:08 2020 -0600

    Update aip/4500.md

    Co-Authored-By: Kelsey Lambert <kelsey.lambert@salesforce.com>

commit f98560f6a66cc5b18c37b73501e2bcd804209a90
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Tue Apr 21 09:59:56 2020 -0600

    Update aip/4500.md

commit 8264e4bbf5a6acd21fc642bf12609b03a33187e2
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Mon Apr 20 14:59:28 2020 -0700

    Updating aria label

    aip-dev#5 updating aria label to salesforce

commit dfb605a0a2ea6c19fe39ce4424bbb73a5834375e
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Sun Apr 19 22:07:53 2020 -0700

    update SVG log

commit b1a78acd63d04022ffa30c5b8b4508242594a7cd
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sun Apr 19 16:53:31 2020 -0600

    Merging latest aip.dev changes into our aip. From the AIP side, this is mostly css and navigation changes

commit 7f4422d8995fd1ed4dcf9353a12d3fa221f34539
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Fri Apr 17 13:13:36 2020 -0700

    Adding salesforce logo SVG

commit 72bb139b91179489f573863b9933c7df63c7bbfb
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Fri Apr 17 13:11:56 2020 -0700

    Adding salesforce logo svg

commit e596ca8debd9907dd92eb93e7fb140de5b70a0f8
Author: Mak Ahmad <mak.ahmad@salesforce.com>
Date:   Tue Apr 14 21:24:14 2020 -0700

     Update to pagination

    There's a lot more changes I want to make for 1.2 so I'm gonna leave it as is for now.

commit ca9559984862793d0859171ea93b6d9bdb144772
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Apr 10 08:56:16 2020 -0600

    Changing reference section to allow for a reference list at the bottom of an AIP.

commit 5670b994446ed5b5d1c7167a12b8c7df1d142645
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 10 08:44:46 2020 -0600

    Update aip/4500.md

    simplification & removal of redundancy

    Co-Authored-By: Kelsey Lambert <kelsey.lambert@salesforce.com>

commit ede62d13f0ed6aaa8a427a5d9145e4ef4c4d082f
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 10 08:37:12 2020 -0600

    Update aip/4500.md

    too repetitive

    Co-Authored-By: Kelsey Lambert <kelsey.lambert@salesforce.com>

commit 87cae072828d84224cba5d89d8b9ee990951ad3c
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 9 17:31:11 2020 -0600

    Adding changes as recommended by documentation

commit 509a7f4ff0c48dc08b342baa5e1776f8f3a9aa4b
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 3 08:34:53 2020 -0600

    Update aip/4500.md

    References section

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit ff2bed0d2cb5458da54f95dbad5126f9e26ff7af
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 3 08:33:50 2020 -0600

    Update aip/4500.md

    MUST to must

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit daf4416f1dbb2f7789ea99aa2a88f481a0cc6893
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 3 08:33:11 2020 -0600

    Update aip/4500.md

    backquotes for code

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 7d34880085226c00d3f943801df3f60e0eb9a600
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 3 08:32:39 2020 -0600

    Update aip/4500.md

    backquote for code

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 188015fdb349e99620f56082991af1e3069ca11a
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 3 08:31:48 2020 -0600

    Update aip/4500.md

    MUST to must

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit b5fbe61a72ce47c3cb2f56fb84406320403a5063
Author: Ray Polk <rpolk@salesforce.com>
Date:   Fri Apr 3 08:31:16 2020 -0600

    Update aip/4500.md

    MUST to must

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 8a3b3d609252a6dd014f5e163df0669977753361
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Apr 2 16:17:32 2020 -0600

    updating with feedback from review

commit f58a52e03eed122781147570f996265664f7c659
Author: Ray Polk <rpolk@salesforce.com>
Date:   Thu Apr 2 13:27:49 2020 -0600

    Initial re-write of Custom Method section.

commit 1498b9ab96df129fc25abb5f7115428c5c4039ce
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Mon Mar 16 00:14:57 2020 -0600

    Updating Style Guide

commit 0044c6a34d96eb34c977de7936b1a6e2ad49be48
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Mar 12 16:20:37 2020 -0600

    Made suggested updates. Also changed the links to use the reference format, which I will add to the style guide. I think it looks cleaner.

commit 9eff5856c94aa2bc88dbb74be2e50f78599d61a0
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Mar 12 15:22:08 2020 -0600

    removing development code that should not be checked in

commit fede1c54fde83322d7cec4de641dbf5699565421
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Mar 12 15:15:48 2020 -0600

    mend

commit d8e72cf5e6a5d8a782dcd4724f5648be3bc3fa14
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Mar 12 15:15:40 2020 -0600

    Breaking out AIP 1 into smaller sections. Re-writing those sections to better match our proposed process. Will bring this process to the API Stewardship Committee.

commit d07a2b55d64da8109eb5ef05a6ef805f0e266944
Author: Kelsey Lambert <kelsey.lambert@salesforce.com>
Date:   Mon Mar 9 10:33:36 2020 -0700

    Update CONTRIBUTING.md

    Co-Authored-By: Ross Hamilton <rhamilton@salesforce.com>

commit 0e7ab2b38128e3e8d9b15e5feceb463915741f32
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Mar 6 11:23:11 2020 -0700

    Update aip/0002.md

commit 6745d6fbc54a3ea89de2b7b9ce6c13ecccb10d03
Merge: 34cc12e 6e869b8
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Mar 6 11:18:59 2020 -0700

    Merge branch 'feature/7' of git.soma.salesforce.com:API-Stewardship/sf.aip.dev into feature/7

commit 34cc12e5917fe7e171e5c5b27ba9ef1215c93a58
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Mar 6 11:18:49 2020 -0700

    making adjustments

commit 6e869b87fef22398284aa2372170f25093c558ff
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Mar 6 11:18:11 2020 -0700

    Update CONTRIBUTING.md

commit 95f070b5bab1e3e334c96ad41c8ff22a43c62bff
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Mar 6 10:55:06 2020 -0700

    Update aip/0002.md

commit 061d682e34e520edf46fd4a1755a12e6711a9a83
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Feb 29 16:23:40 2020 -0700

    Updating contributing information. This is more about how to contribute and less about the guidelines. Most of the guidelines will be included in the style guide.

commit 05b6932ffef279fa587ed8769470dc31635336bc
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Sat Feb 29 13:52:20 2020 -0700

    aip-dev#12 re-writing numbering descriptions in AIP-2. This is numbering ssystem is very temporary, but want it documented in case we do release with it for a while.

commit 2b741c021ced05ee74b7c33b8ee99219180d8289
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Feb 28 15:46:22 2020 -0700

    aip-dev#15 I had previously rewritten this AIP from the [Home Page](https://git.soma.salesforce.com/pages/API-Stewardship/RESTful-APIs-Conventions-and-Standards/) of the 1.1 standard. This was before anybody else joined. I would like to get any initial feedback from Kelsey and the team on the content and more importantly the style and conventions used here. Initial PR is available [here](https://git.soma.salesforce.com/API-Stewardship/sf.aip.dev/pull/2/files) if you would like to see a diff.

commit 41a547ac7a73b7a843972d0a08706e6a14cb0544
Merge: 79de3fc 96a78b1
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jan 24 17:02:23 2020 -0700

    Merge pull request aip-dev#3 from API-Stewardship/dev/navigation

    Dev/navigation

commit 96a78b122e11c6f5c0442e20764ed851b00d729f
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jan 24 17:00:34 2020 -0700

    Adding navigation specific to salesforce aip

commit 4dfff2d01c97cf70f1343fbcb0a23f9bc8ec82be
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Fri Jan 24 13:32:29 2020 -0700

    Merging changes from aip.dev, including updated navigation controls

commit 79de3fc1025b3f2adfc11fd2e8e477162ee1dea2
Merge: 296e507 00c9c84
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jan 16 17:16:52 2020 -0700

    Merge pull request #2 from API-Stewardship/edit/1000

    Changed the wording to fit into AIP format. Added a bit more descript…

commit 00c9c84b66f6450e56b773d59e3f6527d9454a16
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Thu Jan 16 17:05:05 2020 -0700

    Changed the wording to fit into AIP format. Added a bit more description around HTTP and REST individually before describing them together.

commit 296e50718f2ccddbcc260c54c7d109a42fc67724
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jan 15 22:42:54 2020 -0700

    Update _config.yml

commit b8e2358f36453165e6e9e38bdee4432d97c0dfdf
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jan 15 21:53:34 2020 -0700

    Adding RESTful APIs standards and conventions document as smaller chunks as they fit into the propossed AIP spec for future AIP adoption.

commit a82a89422ce982321647b89f46bd7fdd030b9e16
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jan 15 16:19:39 2020 -0700

    updating again

commit 27a46d650f45775a066d06a40d108bd64136fdef
Author: Ross Hamilton <rhamilton@salesforce.com>
Date:   Wed Jan 15 16:14:48 2020 -0700

    update to work on internal poc origin
@danbars
Copy link

danbars commented Jun 6, 2021

Hi, assuming that I'd like to adopt the format into my organisation, but as an internal portal rather than part of the public aip.dev.
Is there a tool that can help building the portal (navigation tree, css, etc) from the sources?

@rhamiltonsf
Copy link
Contributor

@danbars, There is not a tool specific to AIPs, but you should be able to fork the repo and run it under your own domain on GitHub Pages or -- with a little more effort -- your own Jekyll server.

There is some guidance under forking here that would be a good place to start.

@dret
Copy link

dret commented Oct 29, 2021

i am assuming that when forking the repo to run it standalone a little cleanup and config is necessary/possible. at the very least:

  • remove the actual AIPs.
  • do some basic github/jekyll config (this is described a little bit).
  • do some branding for this to become the ACME AIP page instead of the Google one.

i am interested to play around with this a little, but instead of me just doing this for myself, i am wondering if there's any interest in maybe fleshing out these "here's how to do your own AIPs" instructions.

@danbars
Copy link

danbars commented Oct 29, 2021 via email

@dret
Copy link

dret commented Oct 30, 2021 via email

@danbars
Copy link

danbars commented Oct 30, 2021 via email

@Tma38banmarino1
Copy link

Most Definitely

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site: feature Website feature requests
Projects
None yet
Development

No branches or pull requests

6 participants
@jgeewax @dret @danbars @rhamiltonsf @Tma38banmarino1 and others