12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242 |
- swagger: "2.0"
- info:
- title: api/v1/activity_service.proto
- version: version not set
- tags:
- - name: ActivityService
- - name: UserService
- - name: AuthService
- - name: IdentityProviderService
- - name: InboxService
- - name: MarkdownService
- - name: ResourceService
- - name: MemoService
- - name: WebhookService
- - name: WorkspaceService
- - name: WorkspaceSettingService
- consumes:
- - application/json
- produces:
- - application/json
- paths:
- /api/v1/activities/{id}:
- get:
- summary: GetActivity returns the activity with the given id.
- operationId: ActivityService_GetActivity
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Activity'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: id
- description: The system-generated unique identifier for the activity.
- in: path
- required: true
- type: integer
- format: int32
- tags:
- - ActivityService
- /api/v1/auth/signin:
- post:
- summary: SignIn signs in the user with the given username and password.
- operationId: AuthService_SignIn
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: username
- description: The username to sign in with.
- in: query
- required: false
- type: string
- - name: password
- description: The password to sign in with.
- in: query
- required: false
- type: string
- - name: neverExpire
- description: Whether the session should never expire.
- in: query
- required: false
- type: boolean
- tags:
- - AuthService
- /api/v1/auth/signin/sso:
- post:
- summary: SignInWithSSO signs in the user with the given SSO code.
- operationId: AuthService_SignInWithSSO
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: idpId
- description: The ID of the SSO provider.
- in: query
- required: false
- type: integer
- format: int32
- - name: code
- description: The code to sign in with.
- in: query
- required: false
- type: string
- - name: redirectUri
- description: The redirect URI.
- in: query
- required: false
- type: string
- tags:
- - AuthService
- /api/v1/auth/signout:
- post:
- summary: SignOut signs out the user.
- operationId: AuthService_SignOut
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- tags:
- - AuthService
- /api/v1/auth/signup:
- post:
- summary: SignUp signs up the user with the given username and password.
- operationId: AuthService_SignUp
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: username
- description: The username to sign up with.
- in: query
- required: false
- type: string
- - name: password
- description: The password to sign up with.
- in: query
- required: false
- type: string
- tags:
- - AuthService
- /api/v1/auth/status:
- post:
- summary: GetAuthStatus returns the current auth status of the user.
- operationId: AuthService_GetAuthStatus
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- tags:
- - AuthService
- /api/v1/identityProviders:
- get:
- summary: ListIdentityProviders lists identity providers.
- operationId: IdentityProviderService_ListIdentityProviders
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListIdentityProvidersResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- tags:
- - IdentityProviderService
- post:
- summary: CreateIdentityProvider creates an identity provider.
- operationId: IdentityProviderService_CreateIdentityProvider
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1IdentityProvider'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: identityProvider
- description: The identityProvider to create.
- in: body
- required: true
- schema:
- $ref: '#/definitions/apiv1IdentityProvider'
- tags:
- - IdentityProviderService
- /api/v1/inboxes:
- get:
- summary: ListInboxes lists inboxes for a user.
- operationId: InboxService_ListInboxes
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListInboxesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: user
- description: 'Format: users/{id}'
- in: query
- required: false
- type: string
- tags:
- - InboxService
- /api/v1/markdown/link:metadata:
- get:
- summary: GetLinkMetadata returns metadata for a given link.
- operationId: MarkdownService_GetLinkMetadata
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1LinkMetadata'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: link
- in: query
- required: false
- type: string
- tags:
- - MarkdownService
- /api/v1/markdown/node:restore:
- post:
- summary: RestoreMarkdownNodes restores the given nodes to markdown content.
- operationId: MarkdownService_RestoreMarkdownNodes
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1RestoreMarkdownNodesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1RestoreMarkdownNodesRequest'
- tags:
- - MarkdownService
- /api/v1/markdown/node:stringify:
- post:
- summary: StringifyMarkdownNodes stringify the given nodes to plain text content.
- operationId: MarkdownService_StringifyMarkdownNodes
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1StringifyMarkdownNodesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1StringifyMarkdownNodesRequest'
- tags:
- - MarkdownService
- /api/v1/markdown:parse:
- post:
- summary: ParseMarkdown parses the given markdown content and returns a list of nodes.
- operationId: MarkdownService_ParseMarkdown
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ParseMarkdownResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1ParseMarkdownRequest'
- tags:
- - MarkdownService
- /api/v1/memos:
- get:
- summary: ListMemos lists memos with pagination and filter.
- operationId: MemoService_ListMemos
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemosResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: pageSize
- description: The maximum number of memos to return.
- in: query
- required: false
- type: integer
- format: int32
- - name: pageToken
- description: |-
- A page token, received from a previous `ListMemos` call.
- Provide this to retrieve the subsequent page.
- in: query
- required: false
- type: string
- - name: filter
- description: |-
- Filter is used to filter memos returned in the list.
- Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
- in: query
- required: false
- type: string
- tags:
- - MemoService
- post:
- summary: CreateMemo creates a memo.
- operationId: MemoService_CreateMemo
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Memo'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1CreateMemoRequest'
- tags:
- - MemoService
- /api/v1/memos/stats:
- get:
- summary: GetUserMemosStats gets stats of memos for a user.
- operationId: MemoService_GetUserMemosStats
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1GetUserMemosStatsResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- name is the name of the user to get stats for.
- Format: users/{id}
- in: query
- required: false
- type: string
- - name: timezone
- description: |-
- timezone location
- Format: uses tz identifier
- https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- in: query
- required: false
- type: string
- - name: filter
- description: Same as ListMemosRequest.filter
- in: query
- required: false
- type: string
- tags:
- - MemoService
- /api/v1/memos:by-uid/{uid}:
- get:
- summary: GetMemoByUid gets a memo by uid
- operationId: MemoService_GetMemoByUid
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Memo'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: uid
- description: The uid of the memo.
- in: path
- required: true
- type: string
- tags:
- - MemoService
- /api/v1/memos:export:
- post:
- summary: ExportMemos exports memos.
- operationId: MemoService_ExportMemos
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ExportMemosResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1ExportMemosRequest'
- tags:
- - MemoService
- /api/v1/memos:search:
- get:
- summary: SearchMemos searches memos.
- operationId: MemoService_SearchMemos
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1SearchMemosResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: filter
- description: |-
- Filter is used to filter memos returned.
- Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
- in: query
- required: false
- type: string
- tags:
- - MemoService
- /api/v1/reactions/{reactionId}:
- delete:
- summary: DeleteMemoReaction deletes a reaction for a memo.
- operationId: MemoService_DeleteMemoReaction
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: reactionId
- in: path
- required: true
- type: integer
- format: int32
- tags:
- - MemoService
- /api/v1/resources:
- get:
- summary: ListResources lists all resources.
- operationId: ResourceService_ListResources
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListResourcesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- tags:
- - ResourceService
- post:
- summary: CreateResource creates a new resource.
- operationId: ResourceService_CreateResource
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Resource'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: resource
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1Resource'
- tags:
- - ResourceService
- /api/v1/resources:by-uid/{uid}:
- get:
- summary: GetResourceByUid returns a resource by uid.
- operationId: ResourceService_GetResourceByUid
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Resource'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: uid
- description: The uid of the resource.
- in: path
- required: true
- type: string
- tags:
- - ResourceService
- /api/v1/resources:search:
- get:
- summary: SearchResources searches memos.
- operationId: ResourceService_SearchResources
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1SearchResourcesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: filter
- in: query
- required: false
- type: string
- tags:
- - ResourceService
- /api/v1/users:
- get:
- summary: ListUsers returns a list of users.
- operationId: UserService_ListUsers
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListUsersResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- tags:
- - UserService
- post:
- summary: CreateUser creates a new user.
- operationId: UserService_CreateUser
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: user
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1User'
- tags:
- - UserService
- /api/v1/users:search:
- get:
- summary: SearchUsers searches users by filter.
- operationId: UserService_SearchUsers
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1SearchUsersResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: filter
- description: |-
- Filter is used to filter users returned in the list.
- Format: "username == 'frank'"
- in: query
- required: false
- type: string
- tags:
- - UserService
- /api/v1/webhooks:
- get:
- summary: ListWebhooks returns a list of webhooks.
- operationId: WebhookService_ListWebhooks
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListWebhooksResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: creatorId
- in: query
- required: false
- type: integer
- format: int32
- tags:
- - WebhookService
- post:
- summary: CreateWebhook creates a new webhook.
- operationId: WebhookService_CreateWebhook
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Webhook'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1CreateWebhookRequest'
- tags:
- - WebhookService
- /api/v1/webhooks/{id}:
- get:
- summary: GetWebhook returns a webhook by id.
- operationId: WebhookService_GetWebhook
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Webhook'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: id
- in: path
- required: true
- type: integer
- format: int32
- tags:
- - WebhookService
- delete:
- summary: DeleteWebhook deletes a webhook by id.
- operationId: WebhookService_DeleteWebhook
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: id
- in: path
- required: true
- type: integer
- format: int32
- tags:
- - WebhookService
- /api/v1/webhooks/{webhook.id}:
- patch:
- summary: UpdateWebhook updates a webhook.
- operationId: WebhookService_UpdateWebhook
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Webhook'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: webhook.id
- in: path
- required: true
- type: integer
- format: int32
- - name: webhook
- in: body
- required: true
- schema:
- type: object
- properties:
- creatorId:
- type: integer
- format: int32
- createTime:
- type: string
- format: date-time
- updateTime:
- type: string
- format: date-time
- rowStatus:
- $ref: '#/definitions/v1RowStatus'
- name:
- type: string
- url:
- type: string
- tags:
- - WebhookService
- /api/v1/workspace/profile:
- get:
- summary: GetWorkspaceProfile returns the workspace profile.
- operationId: WorkspaceService_GetWorkspaceProfile
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1WorkspaceProfile'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- tags:
- - WorkspaceService
- /api/v1/workspace/{name}:
- get:
- summary: GetWorkspaceSetting returns the setting by name.
- operationId: WorkspaceSettingService_GetWorkspaceSetting
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1WorkspaceSetting'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The resource name of the workspace setting.
- Format: settings/{setting}
- in: path
- required: true
- type: string
- pattern: settings/[^/]+
- tags:
- - WorkspaceSettingService
- /api/v1/workspace/{setting.name}:
- patch:
- summary: SetWorkspaceSetting updates the setting.
- operationId: WorkspaceSettingService_SetWorkspaceSetting
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1WorkspaceSetting'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: setting.name
- description: |-
- name is the name of the setting.
- Format: settings/{setting}
- in: path
- required: true
- type: string
- pattern: settings/[^/]+
- - name: setting
- description: setting is the setting to update.
- in: body
- required: true
- schema:
- type: object
- properties:
- generalSetting:
- $ref: '#/definitions/apiv1WorkspaceGeneralSetting'
- storageSetting:
- $ref: '#/definitions/apiv1WorkspaceStorageSetting'
- memoRelatedSetting:
- $ref: '#/definitions/apiv1WorkspaceMemoRelatedSetting'
- title: setting is the setting to update.
- tags:
- - WorkspaceSettingService
- /api/v1/{identityProvider.name}:
- patch:
- summary: UpdateIdentityProvider updates an identity provider.
- operationId: IdentityProviderService_UpdateIdentityProvider
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1IdentityProvider'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: identityProvider.name
- description: |-
- The name of the identityProvider.
- Format: identityProviders/{id}
- in: path
- required: true
- type: string
- pattern: identityProviders/[^/]+
- - name: identityProvider
- description: The identityProvider to update.
- in: body
- required: true
- schema:
- type: object
- properties:
- type:
- $ref: '#/definitions/apiv1IdentityProviderType'
- title:
- type: string
- identifierFilter:
- type: string
- config:
- $ref: '#/definitions/apiv1IdentityProviderConfig'
- title: The identityProvider to update.
- tags:
- - IdentityProviderService
- /api/v1/{inbox.name}:
- patch:
- summary: UpdateInbox updates an inbox.
- operationId: InboxService_UpdateInbox
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Inbox'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: inbox.name
- description: |-
- The name of the inbox.
- Format: inboxes/{id}
- in: path
- required: true
- type: string
- pattern: inboxes/[^/]+
- - name: inbox
- in: body
- required: true
- schema:
- type: object
- properties:
- sender:
- type: string
- title: 'Format: users/{id}'
- receiver:
- type: string
- title: 'Format: users/{id}'
- status:
- $ref: '#/definitions/v1InboxStatus'
- createTime:
- type: string
- format: date-time
- type:
- $ref: '#/definitions/v1InboxType'
- activityId:
- type: integer
- format: int32
- tags:
- - InboxService
- /api/v1/{memo.name}:
- patch:
- summary: UpdateMemo updates a memo.
- operationId: MemoService_UpdateMemo
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Memo'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: memo.name
- description: |-
- The name of the memo.
- Format: memos/{id}
- id is the system generated id.
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: memo
- in: body
- required: true
- schema:
- type: object
- properties:
- uid:
- type: string
- description: The user defined id of the memo.
- rowStatus:
- $ref: '#/definitions/v1RowStatus'
- creator:
- type: string
- title: |-
- The name of the creator.
- Format: users/{id}
- createTime:
- type: string
- format: date-time
- updateTime:
- type: string
- format: date-time
- displayTime:
- type: string
- format: date-time
- content:
- type: string
- nodes:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- readOnly: true
- visibility:
- $ref: '#/definitions/v1Visibility'
- tags:
- type: array
- items:
- type: string
- pinned:
- type: boolean
- parentId:
- type: integer
- format: int32
- readOnly: true
- resources:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Resource'
- readOnly: true
- relations:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1MemoRelation'
- readOnly: true
- reactions:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Reaction'
- readOnly: true
- property:
- $ref: '#/definitions/v1MemoProperty'
- readOnly: true
- parent:
- type: string
- title: |-
- The name of the parent memo.
- Format: memos/{id}
- readOnly: true
- snippet:
- type: string
- description: The snippet of the memo content. Plain text only.
- tags:
- - MemoService
- /api/v1/{name_1}:
- get:
- summary: GetIdentityProvider gets an identity provider.
- operationId: IdentityProviderService_GetIdentityProvider
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1IdentityProvider'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_1
- description: |-
- The name of the identityProvider to get.
- Format: identityProviders/{id}
- in: path
- required: true
- type: string
- pattern: identityProviders/[^/]+
- tags:
- - IdentityProviderService
- delete:
- summary: DeleteIdentityProvider deletes an identity provider.
- operationId: IdentityProviderService_DeleteIdentityProvider
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_1
- description: |-
- The name of the identityProvider to delete.
- Format: identityProviders/{id}
- in: path
- required: true
- type: string
- pattern: identityProviders/[^/]+
- tags:
- - IdentityProviderService
- /api/v1/{name_2}:
- get:
- summary: GetResource returns a resource by name.
- operationId: ResourceService_GetResource
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Resource'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_2
- description: |-
- The name of the resource.
- Format: resources/{id}
- id is the system generated unique identifier.
- in: path
- required: true
- type: string
- pattern: resources/[^/]+
- tags:
- - ResourceService
- delete:
- summary: DeleteInbox deletes an inbox.
- operationId: InboxService_DeleteInbox
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_2
- description: |-
- The name of the inbox to delete.
- Format: inboxes/{id}
- in: path
- required: true
- type: string
- pattern: inboxes/[^/]+
- tags:
- - InboxService
- /api/v1/{name_3}:
- get:
- summary: GetMemo gets a memo.
- operationId: MemoService_GetMemo
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Memo'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_3
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- delete:
- summary: DeleteResource deletes a resource by name.
- operationId: ResourceService_DeleteResource
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_3
- description: |-
- The name of the resource.
- Format: resources/{id}
- id is the system generated unique identifier.
- in: path
- required: true
- type: string
- pattern: resources/[^/]+
- tags:
- - ResourceService
- /api/v1/{name_4}:
- delete:
- summary: DeleteMemo deletes a memo.
- operationId: MemoService_DeleteMemo
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name_4
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- /api/v1/{name}:
- get:
- summary: GetUser gets a user by name.
- operationId: UserService_GetUser
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- tags:
- - UserService
- delete:
- summary: DeleteUser deletes a user.
- operationId: UserService_DeleteUser
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- tags:
- - UserService
- /api/v1/{name}/access_tokens:
- get:
- summary: ListUserAccessTokens returns a list of access tokens for a user.
- operationId: UserService_ListUserAccessTokens
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListUserAccessTokensResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- tags:
- - UserService
- post:
- summary: CreateUserAccessToken creates a new access token for a user.
- operationId: UserService_CreateUserAccessToken
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1UserAccessToken'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/UserServiceCreateUserAccessTokenBody'
- tags:
- - UserService
- /api/v1/{name}/access_tokens/{accessToken}:
- delete:
- summary: DeleteUserAccessToken deletes an access token for a user.
- operationId: UserService_DeleteUserAccessToken
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- - name: accessToken
- description: access_token is the access token to delete.
- in: path
- required: true
- type: string
- tags:
- - UserService
- /api/v1/{name}/comments:
- get:
- summary: ListMemoComments lists comments for a memo.
- operationId: MemoService_ListMemoComments
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemoCommentsResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- post:
- summary: CreateMemoComment creates a comment for a memo.
- operationId: MemoService_CreateMemoComment
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Memo'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: comment
- in: body
- required: true
- schema:
- $ref: '#/definitions/v1CreateMemoRequest'
- tags:
- - MemoService
- /api/v1/{name}/properties:
- get:
- summary: ListMemoProperties lists memo properties.
- operationId: MemoService_ListMemoProperties
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemoPropertiesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}. Use "memos/-" to list all properties.
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- /api/v1/{name}/properties:rebuild:
- post:
- summary: RebuildMemoProperty rebuilds a memo property.
- operationId: MemoService_RebuildMemoProperty
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}. Use "memos/-" to rebuild all memos.
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/MemoServiceRebuildMemoPropertyBody'
- tags:
- - MemoService
- /api/v1/{name}/reactions:
- get:
- summary: ListMemoReactions lists reactions for a memo.
- operationId: MemoService_ListMemoReactions
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemoReactionsResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- post:
- summary: UpsertMemoReaction upserts a reaction for a memo.
- operationId: MemoService_UpsertMemoReaction
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Reaction'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/MemoServiceUpsertMemoReactionBody'
- tags:
- - MemoService
- /api/v1/{name}/relations:
- get:
- summary: ListMemoRelations lists relations for a memo.
- operationId: MemoService_ListMemoRelations
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemoRelationsResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- patch:
- summary: SetMemoRelations sets relations for a memo.
- operationId: MemoService_SetMemoRelations
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/MemoServiceSetMemoRelationsBody'
- tags:
- - MemoService
- /api/v1/{name}/resources:
- get:
- summary: ListMemoResources lists resources for a memo.
- operationId: MemoService_ListMemoResources
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemoResourcesResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- tags:
- - MemoService
- patch:
- summary: SetMemoResources sets resources for a memo.
- operationId: MemoService_SetMemoResources
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the memo.
- Format: memos/{id}
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/MemoServiceSetMemoResourcesBody'
- tags:
- - MemoService
- /api/v1/{name}/setting:
- get:
- summary: GetUserSetting gets the setting of a user.
- operationId: UserService_GetUserSetting
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1UserSetting'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- tags:
- - UserService
- /api/v1/{parent}/tags:
- get:
- summary: ListMemoTags lists tags for a memo.
- operationId: MemoService_ListMemoTags
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1ListMemoTagsResponse'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: parent
- description: |-
- The parent, who owns the tags.
- Format: memos/{id}. Use "memos/-" to list all tags.
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: filter
- description: |-
- Filter is used to filter memos.
- Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
- in: query
- required: false
- type: string
- tags:
- - MemoService
- /api/v1/{parent}/tags/{tag}:
- delete:
- summary: DeleteMemoTag deletes a tag for a memo.
- operationId: MemoService_DeleteMemoTag
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: parent
- description: |-
- The parent, who owns the tags.
- Format: memos/{id}. Use "memos/-" to delete all tags.
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: tag
- in: path
- required: true
- type: string
- - name: deleteRelatedMemos
- in: query
- required: false
- type: boolean
- tags:
- - MemoService
- /api/v1/{parent}/tags:rename:
- patch:
- summary: RenameMemoTag renames a tag for a memo.
- operationId: MemoService_RenameMemoTag
- responses:
- "200":
- description: A successful response.
- schema:
- type: object
- properties: {}
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: parent
- description: |-
- The parent, who owns the tags.
- Format: memos/{id}. Use "memos/-" to rename all tags.
- in: path
- required: true
- type: string
- pattern: memos/[^/]+
- - name: body
- in: body
- required: true
- schema:
- $ref: '#/definitions/MemoServiceRenameMemoTagBody'
- tags:
- - MemoService
- /api/v1/{resource.name}:
- patch:
- summary: UpdateResource updates a resource.
- operationId: ResourceService_UpdateResource
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1Resource'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: resource.name
- description: |-
- The name of the resource.
- Format: resources/{id}
- id is the system generated unique identifier.
- in: path
- required: true
- type: string
- pattern: resources/[^/]+
- - name: resource
- in: body
- required: true
- schema:
- type: object
- properties:
- uid:
- type: string
- description: The user defined id of the resource.
- createTime:
- type: string
- format: date-time
- readOnly: true
- filename:
- type: string
- content:
- type: string
- format: byte
- externalLink:
- type: string
- type:
- type: string
- size:
- type: string
- format: int64
- memo:
- type: string
- title: |-
- The related memo.
- Format: memos/{id}
- tags:
- - ResourceService
- /api/v1/{setting.name}:
- patch:
- summary: UpdateUserSetting updates the setting of a user.
- operationId: UserService_UpdateUserSetting
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiv1UserSetting'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: setting.name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+/setting
- - name: setting
- in: body
- required: true
- schema:
- type: object
- properties:
- locale:
- type: string
- description: The preferred locale of the user.
- appearance:
- type: string
- description: The preferred appearance of the user.
- memoVisibility:
- type: string
- description: The default visibility of the memo.
- tags:
- - UserService
- /api/v1/{user.name}:
- patch:
- summary: UpdateUser updates a user.
- operationId: UserService_UpdateUser
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/v1User'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: user.name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- - name: user
- in: body
- required: true
- schema:
- type: object
- properties:
- id:
- type: integer
- format: int32
- description: The system generated uid of the user.
- role:
- $ref: '#/definitions/UserRole'
- username:
- type: string
- email:
- type: string
- nickname:
- type: string
- avatarUrl:
- type: string
- description:
- type: string
- password:
- type: string
- rowStatus:
- $ref: '#/definitions/v1RowStatus'
- createTime:
- type: string
- format: date-time
- updateTime:
- type: string
- format: date-time
- tags:
- - UserService
- /file/{name}/avatar:
- get:
- summary: GetUserAvatarBinary gets the avatar of a user.
- operationId: UserService_GetUserAvatarBinary
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiHttpBody'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the user.
- Format: users/{id}
- in: path
- required: true
- type: string
- pattern: users/[^/]+
- - name: httpBody.contentType
- description: The HTTP Content-Type header value specifying the content type of the body.
- in: query
- required: false
- type: string
- - name: httpBody.data
- description: The HTTP request/response body as raw binary.
- in: query
- required: false
- type: string
- format: byte
- tags:
- - UserService
- /file/{name}/{filename}:
- get:
- summary: GetResourceBinary returns a resource binary by name.
- operationId: ResourceService_GetResourceBinary
- responses:
- "200":
- description: A successful response.
- schema:
- $ref: '#/definitions/apiHttpBody'
- default:
- description: An unexpected error response.
- schema:
- $ref: '#/definitions/googlerpcStatus'
- parameters:
- - name: name
- description: |-
- The name of the resource.
- Format: resources/{id}
- id is the system generated unique identifier.
- in: path
- required: true
- type: string
- pattern: resources/[^/]+
- - name: filename
- description: The filename of the resource. Mainly used for downloading.
- in: path
- required: true
- type: string
- tags:
- - ResourceService
- definitions:
- MemoServiceRebuildMemoPropertyBody:
- type: object
- MemoServiceRenameMemoTagBody:
- type: object
- properties:
- oldTag:
- type: string
- newTag:
- type: string
- MemoServiceSetMemoRelationsBody:
- type: object
- properties:
- relations:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1MemoRelation'
- MemoServiceSetMemoResourcesBody:
- type: object
- properties:
- resources:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Resource'
- MemoServiceUpsertMemoReactionBody:
- type: object
- properties:
- reaction:
- $ref: '#/definitions/v1Reaction'
- TableNodeRow:
- type: object
- properties:
- cells:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- UserRole:
- type: string
- enum:
- - ROLE_UNSPECIFIED
- - HOST
- - ADMIN
- - USER
- default: ROLE_UNSPECIFIED
- UserServiceCreateUserAccessTokenBody:
- type: object
- properties:
- description:
- type: string
- expiresAt:
- type: string
- format: date-time
- WorkspaceStorageSettingS3Config:
- type: object
- properties:
- accessKeyId:
- type: string
- accessKeySecret:
- type: string
- endpoint:
- type: string
- region:
- type: string
- bucket:
- type: string
- title: 'Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/'
- apiHttpBody:
- type: object
- properties:
- contentType:
- type: string
- description: The HTTP Content-Type header value specifying the content type of the body.
- data:
- type: string
- format: byte
- description: The HTTP request/response body as raw binary.
- extensions:
- type: array
- items:
- type: object
- $ref: '#/definitions/protobufAny'
- description: |-
- Application specific response metadata. Must be set in the first response
- for streaming APIs.
- description: |-
- Message that represents an arbitrary HTTP body. It should only be used for
- payload formats that can't be represented as JSON, such as raw binary or
- an HTML page.
- This message can be used both in streaming and non-streaming API methods in
- the request as well as the response.
- It can be used as a top-level request field, which is convenient if one
- wants to extract parameters from either the URL or HTTP template into the
- request fields and also want access to the raw HTTP body.
- Example:
- message GetResourceRequest {
- // A unique request id.
- string request_id = 1;
- // The raw HTTP body is bound to this field.
- google.api.HttpBody http_body = 2;
- }
- service ResourceService {
- rpc GetResource(GetResourceRequest)
- returns (google.api.HttpBody);
- rpc UpdateResource(google.api.HttpBody)
- returns (google.protobuf.Empty);
- }
- Example with streaming methods:
- service CaldavService {
- rpc GetCalendar(stream google.api.HttpBody)
- returns (stream google.api.HttpBody);
- rpc UpdateCalendar(stream google.api.HttpBody)
- returns (stream google.api.HttpBody);
- }
- Use of this type only changes how the request and response bodies are
- handled, all other features will continue to work unchanged.
- apiv1ActivityMemoCommentPayload:
- type: object
- properties:
- memoId:
- type: integer
- format: int32
- description: The memo id of comment.
- relatedMemoId:
- type: integer
- format: int32
- description: The memo id of related memo.
- description: ActivityMemoCommentPayload represents the payload of a memo comment activity.
- apiv1ActivityPayload:
- type: object
- properties:
- memoComment:
- $ref: '#/definitions/apiv1ActivityMemoCommentPayload'
- versionUpdate:
- $ref: '#/definitions/apiv1ActivityVersionUpdatePayload'
- apiv1ActivityVersionUpdatePayload:
- type: object
- properties:
- version:
- type: string
- description: The updated version of memos.
- apiv1FieldMapping:
- type: object
- properties:
- identifier:
- type: string
- displayName:
- type: string
- email:
- type: string
- apiv1IdentityProvider:
- type: object
- properties:
- name:
- type: string
- title: |-
- The name of the identityProvider.
- Format: identityProviders/{id}
- type:
- $ref: '#/definitions/apiv1IdentityProviderType'
- title:
- type: string
- identifierFilter:
- type: string
- config:
- $ref: '#/definitions/apiv1IdentityProviderConfig'
- apiv1IdentityProviderConfig:
- type: object
- properties:
- oauth2Config:
- $ref: '#/definitions/apiv1OAuth2Config'
- apiv1IdentityProviderType:
- type: string
- enum:
- - TYPE_UNSPECIFIED
- - OAUTH2
- default: TYPE_UNSPECIFIED
- apiv1OAuth2Config:
- type: object
- properties:
- clientId:
- type: string
- clientSecret:
- type: string
- authUrl:
- type: string
- tokenUrl:
- type: string
- userInfoUrl:
- type: string
- scopes:
- type: array
- items:
- type: string
- fieldMapping:
- $ref: '#/definitions/apiv1FieldMapping'
- apiv1UserSetting:
- type: object
- properties:
- name:
- type: string
- title: |-
- The name of the user.
- Format: users/{id}
- locale:
- type: string
- description: The preferred locale of the user.
- appearance:
- type: string
- description: The preferred appearance of the user.
- memoVisibility:
- type: string
- description: The default visibility of the memo.
- apiv1WorkspaceCustomProfile:
- type: object
- properties:
- title:
- type: string
- description:
- type: string
- logoUrl:
- type: string
- locale:
- type: string
- appearance:
- type: string
- apiv1WorkspaceGeneralSetting:
- type: object
- properties:
- additionalScript:
- type: string
- description: additional_script is the additional script.
- additionalStyle:
- type: string
- description: additional_style is the additional style.
- customProfile:
- $ref: '#/definitions/apiv1WorkspaceCustomProfile'
- description: custom_profile is the custom profile.
- apiv1WorkspaceMemoRelatedSetting:
- type: object
- properties:
- disallowPublicVisibility:
- type: boolean
- description: disallow_public_visibility disallows set memo as public visibility.
- displayWithUpdateTime:
- type: boolean
- description: display_with_update_time orders and displays memo with update time.
- contentLengthLimit:
- type: integer
- format: int32
- description: content_length_limit is the limit of content length. Unit is byte.
- enableAutoCompact:
- type: boolean
- description: enable_auto_compact enables auto compact for large content.
- enableDoubleClickEdit:
- type: boolean
- description: enable_double_click_edit enables editing on double click.
- enableLinkPreview:
- type: boolean
- description: enable_link_preview enables links preview.
- apiv1WorkspaceSetting:
- type: object
- properties:
- name:
- type: string
- title: |-
- name is the name of the setting.
- Format: settings/{setting}
- generalSetting:
- $ref: '#/definitions/apiv1WorkspaceGeneralSetting'
- storageSetting:
- $ref: '#/definitions/apiv1WorkspaceStorageSetting'
- memoRelatedSetting:
- $ref: '#/definitions/apiv1WorkspaceMemoRelatedSetting'
- apiv1WorkspaceStorageSetting:
- type: object
- properties:
- storageType:
- $ref: '#/definitions/apiv1WorkspaceStorageSettingStorageType'
- description: storage_type is the storage type.
- filepathTemplate:
- type: string
- title: |-
- The template of file path.
- e.g. assets/{timestamp}_{filename}
- uploadSizeLimitMb:
- type: string
- format: int64
- description: The max upload size in megabytes.
- s3Config:
- $ref: '#/definitions/WorkspaceStorageSettingS3Config'
- description: The S3 config.
- apiv1WorkspaceStorageSettingStorageType:
- type: string
- enum:
- - STORAGE_TYPE_UNSPECIFIED
- - DATABASE
- - LOCAL
- - S3
- default: STORAGE_TYPE_UNSPECIFIED
- description: |2-
- - DATABASE: DATABASE is the database storage type.
- - LOCAL: LOCAL is the local storage type.
- - S3: S3 is the S3 storage type.
- googlerpcStatus:
- type: object
- properties:
- code:
- type: integer
- format: int32
- message:
- type: string
- details:
- type: array
- items:
- type: object
- $ref: '#/definitions/protobufAny'
- protobufAny:
- type: object
- properties:
- '@type':
- type: string
- description: |-
- A URL/resource name that uniquely identifies the type of the serialized
- protocol buffer message. This string must contain at least
- one "/" character. The last segment of the URL's path must represent
- the fully qualified name of the type (as in
- `path/google.protobuf.Duration`). The name should be in a canonical form
- (e.g., leading "." is not accepted).
- In practice, teams usually precompile into the binary all types that they
- expect it to use in the context of Any. However, for URLs which use the
- scheme `http`, `https`, or no scheme, one can optionally set up a type
- server that maps type URLs to message definitions as follows:
- * If no scheme is provided, `https` is assumed.
- * An HTTP GET on the URL must yield a [google.protobuf.Type][]
- value in binary format, or produce an error.
- * Applications are allowed to cache lookup results based on the
- URL, or have them precompiled into a binary to avoid any
- lookup. Therefore, binary compatibility needs to be preserved
- on changes to types. (Use versioned type names to manage
- breaking changes.)
- Note: this functionality is not currently available in the official
- protobuf release, and it is not used for type URLs beginning with
- type.googleapis.com. As of May 2023, there are no widely used type server
- implementations and no plans to implement one.
- Schemes other than `http`, `https` (or the empty scheme) might be
- used with implementation specific semantics.
- additionalProperties: {}
- description: |-
- `Any` contains an arbitrary serialized protocol buffer message along with a
- URL that describes the type of the serialized message.
- Protobuf library provides support to pack/unpack Any values in the form
- of utility functions or additional generated methods of the Any type.
- Example 1: Pack and unpack a message in C++.
- Foo foo = ...;
- Any any;
- any.PackFrom(foo);
- ...
- if (any.UnpackTo(&foo)) {
- ...
- }
- Example 2: Pack and unpack a message in Java.
- Foo foo = ...;
- Any any = Any.pack(foo);
- ...
- if (any.is(Foo.class)) {
- foo = any.unpack(Foo.class);
- }
- // or ...
- if (any.isSameTypeAs(Foo.getDefaultInstance())) {
- foo = any.unpack(Foo.getDefaultInstance());
- }
- Example 3: Pack and unpack a message in Python.
- foo = Foo(...)
- any = Any()
- any.Pack(foo)
- ...
- if any.Is(Foo.DESCRIPTOR):
- any.Unpack(foo)
- ...
- Example 4: Pack and unpack a message in Go
- foo := &pb.Foo{...}
- any, err := anypb.New(foo)
- if err != nil {
- ...
- }
- ...
- foo := &pb.Foo{}
- if err := any.UnmarshalTo(foo); err != nil {
- ...
- }
- The pack methods provided by protobuf library will by default use
- 'type.googleapis.com/full.type.name' as the type URL and the unpack
- methods only use the fully qualified type name after the last '/'
- in the type URL, for example "foo.bar.com/x/y.z" will yield type
- name "y.z".
- JSON
- ====
- The JSON representation of an `Any` value uses the regular
- representation of the deserialized, embedded message, with an
- additional field `@type` which contains the type URL. Example:
- package google.profile;
- message Person {
- string first_name = 1;
- string last_name = 2;
- }
- {
- "@type": "type.googleapis.com/google.profile.Person",
- "firstName": <string>,
- "lastName": <string>
- }
- If the embedded message type is well-known and has a custom JSON
- representation, that representation will be embedded adding a field
- `value` which holds the custom JSON in addition to the `@type`
- field. Example (for message [google.protobuf.Duration][]):
- {
- "@type": "type.googleapis.com/google.protobuf.Duration",
- "value": "1.212s"
- }
- v1Activity:
- type: object
- properties:
- id:
- type: integer
- format: int32
- description: The system-generated unique identifier for the activity.
- creatorId:
- type: integer
- format: int32
- description: The system-generated unique identifier for the user who created the activity.
- type:
- type: string
- description: The type of the activity.
- level:
- type: string
- description: The level of the activity.
- createTime:
- type: string
- format: date-time
- description: The create time of the activity.
- readOnly: true
- payload:
- $ref: '#/definitions/apiv1ActivityPayload'
- description: The payload of the activity.
- v1AutoLinkNode:
- type: object
- properties:
- url:
- type: string
- isRawText:
- type: boolean
- v1BlockquoteNode:
- type: object
- properties:
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1BoldItalicNode:
- type: object
- properties:
- symbol:
- type: string
- content:
- type: string
- v1BoldNode:
- type: object
- properties:
- symbol:
- type: string
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1CodeBlockNode:
- type: object
- properties:
- language:
- type: string
- content:
- type: string
- v1CodeNode:
- type: object
- properties:
- content:
- type: string
- v1CreateMemoRequest:
- type: object
- properties:
- content:
- type: string
- visibility:
- $ref: '#/definitions/v1Visibility'
- v1CreateWebhookRequest:
- type: object
- properties:
- name:
- type: string
- url:
- type: string
- v1EmbeddedContentNode:
- type: object
- properties:
- resourceName:
- type: string
- params:
- type: string
- v1EscapingCharacterNode:
- type: object
- properties:
- symbol:
- type: string
- v1ExportMemosRequest:
- type: object
- properties:
- filter:
- type: string
- title: Same as ListMemosRequest.filter
- v1ExportMemosResponse:
- type: object
- properties:
- content:
- type: string
- format: byte
- v1GetUserMemosStatsResponse:
- type: object
- properties:
- stats:
- type: object
- additionalProperties:
- type: integer
- format: int32
- description: |-
- stats is the stats of memo creating/updating activities.
- key is the year-month-day string. e.g. "2020-01-01".
- v1HTMLElementNode:
- type: object
- properties:
- tagName:
- type: string
- attributes:
- type: object
- additionalProperties:
- type: string
- v1HeadingNode:
- type: object
- properties:
- level:
- type: integer
- format: int32
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1HighlightNode:
- type: object
- properties:
- content:
- type: string
- v1HorizontalRuleNode:
- type: object
- properties:
- symbol:
- type: string
- v1ImageNode:
- type: object
- properties:
- altText:
- type: string
- url:
- type: string
- v1Inbox:
- type: object
- properties:
- name:
- type: string
- title: |-
- The name of the inbox.
- Format: inboxes/{id}
- sender:
- type: string
- title: 'Format: users/{id}'
- receiver:
- type: string
- title: 'Format: users/{id}'
- status:
- $ref: '#/definitions/v1InboxStatus'
- createTime:
- type: string
- format: date-time
- type:
- $ref: '#/definitions/v1InboxType'
- activityId:
- type: integer
- format: int32
- v1InboxStatus:
- type: string
- enum:
- - STATUS_UNSPECIFIED
- - UNREAD
- - ARCHIVED
- default: STATUS_UNSPECIFIED
- v1InboxType:
- type: string
- enum:
- - TYPE_UNSPECIFIED
- - MEMO_COMMENT
- - VERSION_UPDATE
- default: TYPE_UNSPECIFIED
- v1ItalicNode:
- type: object
- properties:
- symbol:
- type: string
- content:
- type: string
- v1LineBreakNode:
- type: object
- v1LinkMetadata:
- type: object
- properties:
- title:
- type: string
- description:
- type: string
- image:
- type: string
- v1LinkNode:
- type: object
- properties:
- text:
- type: string
- url:
- type: string
- v1ListIdentityProvidersResponse:
- type: object
- properties:
- identityProviders:
- type: array
- items:
- type: object
- $ref: '#/definitions/apiv1IdentityProvider'
- v1ListInboxesResponse:
- type: object
- properties:
- inboxes:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Inbox'
- v1ListMemoCommentsResponse:
- type: object
- properties:
- memos:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Memo'
- v1ListMemoPropertiesResponse:
- type: object
- properties:
- properties:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1MemoProperty'
- v1ListMemoReactionsResponse:
- type: object
- properties:
- reactions:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Reaction'
- v1ListMemoRelationsResponse:
- type: object
- properties:
- relations:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1MemoRelation'
- v1ListMemoResourcesResponse:
- type: object
- properties:
- resources:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Resource'
- v1ListMemoTagsResponse:
- type: object
- properties:
- tagAmounts:
- type: object
- additionalProperties:
- type: integer
- format: int32
- description: |-
- tag_amounts is the amount of tags.
- key is the tag name. e.g. "tag1".
- value is the amount of the tag.
- v1ListMemosResponse:
- type: object
- properties:
- memos:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Memo'
- nextPageToken:
- type: string
- description: |-
- A token, which can be sent as `page_token` to retrieve the next page.
- If this field is omitted, there are no subsequent pages.
- v1ListResourcesResponse:
- type: object
- properties:
- resources:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Resource'
- v1ListUserAccessTokensResponse:
- type: object
- properties:
- accessTokens:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1UserAccessToken'
- v1ListUsersResponse:
- type: object
- properties:
- users:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1User'
- v1ListWebhooksResponse:
- type: object
- properties:
- webhooks:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Webhook'
- v1MathBlockNode:
- type: object
- properties:
- content:
- type: string
- v1MathNode:
- type: object
- properties:
- content:
- type: string
- v1Memo:
- type: object
- properties:
- name:
- type: string
- description: |-
- The name of the memo.
- Format: memos/{id}
- id is the system generated id.
- uid:
- type: string
- description: The user defined id of the memo.
- rowStatus:
- $ref: '#/definitions/v1RowStatus'
- creator:
- type: string
- title: |-
- The name of the creator.
- Format: users/{id}
- createTime:
- type: string
- format: date-time
- updateTime:
- type: string
- format: date-time
- displayTime:
- type: string
- format: date-time
- content:
- type: string
- nodes:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- readOnly: true
- visibility:
- $ref: '#/definitions/v1Visibility'
- tags:
- type: array
- items:
- type: string
- pinned:
- type: boolean
- parentId:
- type: integer
- format: int32
- readOnly: true
- resources:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Resource'
- readOnly: true
- relations:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1MemoRelation'
- readOnly: true
- reactions:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Reaction'
- readOnly: true
- property:
- $ref: '#/definitions/v1MemoProperty'
- readOnly: true
- parent:
- type: string
- title: |-
- The name of the parent memo.
- Format: memos/{id}
- readOnly: true
- snippet:
- type: string
- description: The snippet of the memo content. Plain text only.
- v1MemoProperty:
- type: object
- properties:
- tags:
- type: array
- items:
- type: string
- hasLink:
- type: boolean
- hasTaskList:
- type: boolean
- hasCode:
- type: boolean
- hasIncompleteTasks:
- type: boolean
- v1MemoRelation:
- type: object
- properties:
- memo:
- type: string
- title: |-
- The name of memo.
- Format: "memos/{uid}"
- relatedMemo:
- type: string
- title: |-
- The name of related memo.
- Format: "memos/{uid}"
- type:
- $ref: '#/definitions/v1MemoRelationType'
- v1MemoRelationType:
- type: string
- enum:
- - TYPE_UNSPECIFIED
- - REFERENCE
- - COMMENT
- default: TYPE_UNSPECIFIED
- v1Node:
- type: object
- properties:
- type:
- $ref: '#/definitions/v1NodeType'
- lineBreakNode:
- $ref: '#/definitions/v1LineBreakNode'
- paragraphNode:
- $ref: '#/definitions/v1ParagraphNode'
- codeBlockNode:
- $ref: '#/definitions/v1CodeBlockNode'
- headingNode:
- $ref: '#/definitions/v1HeadingNode'
- horizontalRuleNode:
- $ref: '#/definitions/v1HorizontalRuleNode'
- blockquoteNode:
- $ref: '#/definitions/v1BlockquoteNode'
- orderedListNode:
- $ref: '#/definitions/v1OrderedListNode'
- unorderedListNode:
- $ref: '#/definitions/v1UnorderedListNode'
- taskListNode:
- $ref: '#/definitions/v1TaskListNode'
- mathBlockNode:
- $ref: '#/definitions/v1MathBlockNode'
- tableNode:
- $ref: '#/definitions/v1TableNode'
- embeddedContentNode:
- $ref: '#/definitions/v1EmbeddedContentNode'
- textNode:
- $ref: '#/definitions/v1TextNode'
- boldNode:
- $ref: '#/definitions/v1BoldNode'
- italicNode:
- $ref: '#/definitions/v1ItalicNode'
- boldItalicNode:
- $ref: '#/definitions/v1BoldItalicNode'
- codeNode:
- $ref: '#/definitions/v1CodeNode'
- imageNode:
- $ref: '#/definitions/v1ImageNode'
- linkNode:
- $ref: '#/definitions/v1LinkNode'
- autoLinkNode:
- $ref: '#/definitions/v1AutoLinkNode'
- tagNode:
- $ref: '#/definitions/v1TagNode'
- strikethroughNode:
- $ref: '#/definitions/v1StrikethroughNode'
- escapingCharacterNode:
- $ref: '#/definitions/v1EscapingCharacterNode'
- mathNode:
- $ref: '#/definitions/v1MathNode'
- highlightNode:
- $ref: '#/definitions/v1HighlightNode'
- subscriptNode:
- $ref: '#/definitions/v1SubscriptNode'
- superscriptNode:
- $ref: '#/definitions/v1SuperscriptNode'
- referencedContentNode:
- $ref: '#/definitions/v1ReferencedContentNode'
- spoilerNode:
- $ref: '#/definitions/v1SpoilerNode'
- htmlElementNode:
- $ref: '#/definitions/v1HTMLElementNode'
- v1NodeType:
- type: string
- enum:
- - NODE_UNSPECIFIED
- - LINE_BREAK
- - PARAGRAPH
- - CODE_BLOCK
- - HEADING
- - HORIZONTAL_RULE
- - BLOCKQUOTE
- - ORDERED_LIST
- - UNORDERED_LIST
- - TASK_LIST
- - MATH_BLOCK
- - TABLE
- - EMBEDDED_CONTENT
- - TEXT
- - BOLD
- - ITALIC
- - BOLD_ITALIC
- - CODE
- - IMAGE
- - LINK
- - AUTO_LINK
- - TAG
- - STRIKETHROUGH
- - ESCAPING_CHARACTER
- - MATH
- - HIGHLIGHT
- - SUBSCRIPT
- - SUPERSCRIPT
- - REFERENCED_CONTENT
- - SPOILER
- - HTML_ELEMENT
- default: NODE_UNSPECIFIED
- v1OrderedListNode:
- type: object
- properties:
- number:
- type: string
- indent:
- type: integer
- format: int32
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1ParagraphNode:
- type: object
- properties:
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1ParseMarkdownRequest:
- type: object
- properties:
- markdown:
- type: string
- v1ParseMarkdownResponse:
- type: object
- properties:
- nodes:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1Reaction:
- type: object
- properties:
- id:
- type: integer
- format: int32
- creator:
- type: string
- title: |-
- The name of the creator.
- Format: users/{id}
- contentId:
- type: string
- reactionType:
- $ref: '#/definitions/v1ReactionType'
- v1ReactionType:
- type: string
- enum:
- - TYPE_UNSPECIFIED
- - THUMBS_UP
- - THUMBS_DOWN
- - HEART
- - FIRE
- - CLAPPING_HANDS
- - LAUGH
- - OK_HAND
- - ROCKET
- - EYES
- - THINKING_FACE
- - CLOWN_FACE
- - QUESTION_MARK
- default: TYPE_UNSPECIFIED
- v1ReferencedContentNode:
- type: object
- properties:
- resourceName:
- type: string
- params:
- type: string
- v1Resource:
- type: object
- properties:
- name:
- type: string
- description: |-
- The name of the resource.
- Format: resources/{id}
- id is the system generated unique identifier.
- uid:
- type: string
- description: The user defined id of the resource.
- createTime:
- type: string
- format: date-time
- readOnly: true
- filename:
- type: string
- content:
- type: string
- format: byte
- externalLink:
- type: string
- type:
- type: string
- size:
- type: string
- format: int64
- memo:
- type: string
- title: |-
- The related memo.
- Format: memos/{id}
- v1RestoreMarkdownNodesRequest:
- type: object
- properties:
- nodes:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1RestoreMarkdownNodesResponse:
- type: object
- properties:
- markdown:
- type: string
- v1RowStatus:
- type: string
- enum:
- - ROW_STATUS_UNSPECIFIED
- - ACTIVE
- - ARCHIVED
- default: ROW_STATUS_UNSPECIFIED
- v1SearchMemosResponse:
- type: object
- properties:
- memos:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Memo'
- v1SearchResourcesResponse:
- type: object
- properties:
- resources:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Resource'
- v1SearchUsersResponse:
- type: object
- properties:
- users:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1User'
- v1SpoilerNode:
- type: object
- properties:
- content:
- type: string
- v1StrikethroughNode:
- type: object
- properties:
- content:
- type: string
- v1StringifyMarkdownNodesRequest:
- type: object
- properties:
- nodes:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1StringifyMarkdownNodesResponse:
- type: object
- properties:
- plainText:
- type: string
- v1SubscriptNode:
- type: object
- properties:
- content:
- type: string
- v1SuperscriptNode:
- type: object
- properties:
- content:
- type: string
- v1TableNode:
- type: object
- properties:
- header:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- delimiter:
- type: array
- items:
- type: string
- rows:
- type: array
- items:
- type: object
- $ref: '#/definitions/TableNodeRow'
- v1TagNode:
- type: object
- properties:
- content:
- type: string
- v1TaskListNode:
- type: object
- properties:
- symbol:
- type: string
- indent:
- type: integer
- format: int32
- complete:
- type: boolean
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1TextNode:
- type: object
- properties:
- content:
- type: string
- v1UnorderedListNode:
- type: object
- properties:
- symbol:
- type: string
- indent:
- type: integer
- format: int32
- children:
- type: array
- items:
- type: object
- $ref: '#/definitions/v1Node'
- v1User:
- type: object
- properties:
- name:
- type: string
- title: |-
- The name of the user.
- Format: users/{id}
- id:
- type: integer
- format: int32
- description: The system generated uid of the user.
- role:
- $ref: '#/definitions/UserRole'
- username:
- type: string
- email:
- type: string
- nickname:
- type: string
- avatarUrl:
- type: string
- description:
- type: string
- password:
- type: string
- rowStatus:
- $ref: '#/definitions/v1RowStatus'
- createTime:
- type: string
- format: date-time
- updateTime:
- type: string
- format: date-time
- v1UserAccessToken:
- type: object
- properties:
- accessToken:
- type: string
- description:
- type: string
- issuedAt:
- type: string
- format: date-time
- expiresAt:
- type: string
- format: date-time
- v1Visibility:
- type: string
- enum:
- - VISIBILITY_UNSPECIFIED
- - PRIVATE
- - PROTECTED
- - PUBLIC
- default: VISIBILITY_UNSPECIFIED
- v1Webhook:
- type: object
- properties:
- id:
- type: integer
- format: int32
- creatorId:
- type: integer
- format: int32
- createTime:
- type: string
- format: date-time
- updateTime:
- type: string
- format: date-time
- rowStatus:
- $ref: '#/definitions/v1RowStatus'
- name:
- type: string
- url:
- type: string
- v1WorkspaceProfile:
- type: object
- properties:
- owner:
- type: string
- title: |-
- The name of instance owner.
- Format: "users/{id}"
- version:
- type: string
- title: version is the current version of instance
- mode:
- type: string
- description: mode is the instance mode (e.g. "prod", "dev" or "demo").
- public:
- type: boolean
- description: public is a flag that the instance is open for other users.
|