SysML v2
SysML v2 प्रोजेक्ट में API और MCP
व्यक्तिगत एक्सेस टोकन से स्क्रिप्ट और AI टूल के ज़रिए SysML v2 मॉडल पढ़ें, खोजें और जांचें, ऐसे परिवर्तन प्रस्तावित करें जिनकी आप Holarch में समीक्षा करके लागू करते हैं, और Systems Modeling API के माध्यम से पढ़ें और कमिट करें, जहां ब्रांच परिवर्तन अनुरोध होते हैं।
इस पृष्ठ पर
अवलोकन
SysML v2 प्रोजेक्ट LML प्रोजेक्ट वाले उसी REST API, MCP एंडपॉइंट और व्यक्तिगत एक्सेस टोकन के साथ काम करते हैं। स्क्रिप्ट और AI टूल मॉडल को एलिमेंट और SysML टेक्स्ट के रूप में पढ़ते हैं, कुछ भी बदलने से पहले टेक्स्ट जांचते हैं, और बदलाव प्रस्तावित करते हैं। जब तक कोई व्यक्ति Holarch में प्रस्ताव की समीक्षा करके उसे लागू नहीं करता, मॉडल में कुछ नहीं बदलता।
पहुंच के तीन तरीके:
- REST API: स्क्रिप्ट और डैशबोर्ड के लिए
https://app.holarch.app/api/v1/projects/<project>/…। यह एलिमेंट, आवश्यकताएं, डायग्नोस्टिक और SysML टेक्स्ट पढ़ता है, और बदलाव किसी प्रस्ताव में जोड़ता है। - MCP: Claude जैसे AI टूल के लिए
https://app.holarch.app/mcp। SysML v2 टूल मॉडल पढ़ते, खोजते और जांचते हैं और बदलाव प्रस्तावित करते हैं। - Systems Modeling API: दूसरे SysML v2 टूल के लिए, OMG Systems Modeling API के आकार में
https://app.holarch.app/api/v1/sysml/…। ब्रांचmainलाइव मॉडल है और केवल पढ़ने के लिए है; हर दूसरी ब्रांच एक परिवर्तन अनुरोध है, और कमिट उसमें जाते हैं। लाइव मॉडल तभी बदलता है जब कोई अनुमोदक Holarch में परिवर्तन अनुरोध लागू करता है।
टोकन, स्कोप, प्रोजेक्ट सूचियां, संगठन स्विच, दर सीमाएं और Claude को जोड़ना LML प्रोजेक्ट जैसा ही है। टोकन बनाने और AI टूल जोड़ने के लिए API और MCP देखें। प्रोग्राम मैप कॉल (GET /api/v1/program-map, GET /api/v1/projects/<project>/items/<item>/trace, और MCP टूल program_map और trace_chain) SysML v2 प्रोजेक्ट और उनके एलिमेंट शामिल करते हैं।
अवधारणाएं
- एलिमेंट: SysML v2 मॉडल का एक आइटम, जैसे part definition, port या requirement। हर एलिमेंट का एक id (एक UUID) होता है। जहाँ भी कोई रूट या टूल id मांगता है, वहाँ
Vehicles::Car::powertrainजैसा पूर्ण नाम भी काम करता है। - Brief: सूचियों में एलिमेंट का संक्षिप्त रूप:
id,type(metaclass, जैसेPartUsage),name,shortName,qualifiedNameऔरowner। - शीर्ष-स्तरीय पैकेज: ऐसा पैकेज जो किसी दूसरे एलिमेंट के भीतर नहीं है। किसी प्रोजेक्ट का SysML टेक्स्ट हर शीर्ष-स्तरीय पैकेज का एक टेक्स्ट है, और पैकेज के बाहर के एलिमेंट के लिए एक टेक्स्ट।
- डायग्नोस्टिक: भाषा कोर को मिली एक समस्या,
code,severity(errorयाwarning),elementId,elementऔरargsके साथ। सिंटैक्स डायग्नोस्टिक एलिमेंट के बजायlineऔरcolदेते हैं। - प्रस्ताव: वे बदलाव जो कोई API क्लाइंट या AI टूल समीक्षा के लिए इकट्ठा करता है। हर टोकन और प्रोजेक्ट के लिए एक प्रस्ताव खुला रहता है। क्लाइंट उसे शीर्षक और सारांश के साथ समीक्षा के लिए भेजता है।
- पेज वाले उत्तर: सूचियां पेजों में आती हैं (
limit,offset)। लंबा SysML टेक्स्ट पंक्तियों के पेजों में आता है (line,lines)। जिस उत्तर में कुछ छोड़ा गया हो, वहtruncated: trueबताता है।
इसका उपयोग कैसे करें
API का उपयोग तब करें जब किसी स्क्रिप्ट या AI टूल को मॉडल चाहिए: उन आवश्यकताओं की रिपोर्ट के लिए जिन्हें संतुष्ट या सत्यापित करने वाले एलिमेंट नहीं हैं, किसी टीम के SysML टेक्स्ट को मॉडल से जांचने के लिए, या किसी AI टूल को मॉडल बदलावों का मसौदा बनाने देने के लिए, जिसकी फिर कोई इंजीनियर समीक्षा करता है।
curl से SysML v2 प्रोजेक्ट पढ़ें
- खाता सेटिंग्स → API टोकन के नीचे एक टोकन बनाएं (देखें API और MCP)।
- अपने प्रोजेक्ट सूचीबद्ध करें:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/projects
SysML v2 प्रोजेक्ट में "language": "sysml2" होता है।
- मॉडल सारांश प्राप्त करें:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/projects/<project>/model
आपको हर metaclass के एलिमेंट की संख्या, शीर्ष-स्तरीय पैकेज और त्रुटियों और चेतावनियों की संख्या दिखती है।
- एलिमेंट ढूंढें, उदाहरण के लिए हर part definition:
curl -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/projects/<project>/elements?type=part%20def&limit=100"
- किसी पैकेज का SysML टेक्स्ट पढ़ें:
curl -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/projects/<project>/sysml?root=Vehicles"
लंबा टेक्स्ट "truncated": true और "next" के साथ समाप्त होता है: वह पंक्ति जिसे आगे line से मांगना है।
प्रस्तावित करने से पहले SysML टेक्स्ट जांचें
- किसी पैकेज का नया टेक्स्ट check रूट पर भेजें:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
-d '{"root": "Vehicles", "text": "package Vehicles { … }"}' \
https://app.holarch.app/api/v1/projects/<project>/sysml/check
- उत्तर पढ़ें। जब टेक्स्ट में कोई सिंटैक्स त्रुटि न हो तो
oktrueहोता है।diagnosticsसिंटैक्स त्रुटियों कोlineऔरcolके साथ सूचीबद्ध करता है, और वे त्रुटियां भी जो टेक्स्ट मॉडल में जोड़ेगा।changesउन मॉडल बदलावों की संख्या है जो टेक्स्ट करता है।
जांच कुछ नहीं बदलती। इसके लिए केवल पढ़ने वाला टोकन चाहिए।
कोई बदलाव प्रस्तावित करें और उसे लागू करें
लिखने वाला टोकन बदलाव टोकन के खुले प्रस्ताव में जोड़ता है। फिर क्लाइंट प्रस्ताव समीक्षा के लिए भेजता है।
- एक बदलाव जोड़ें। या तो किसी पैकेज का पूरा नया टेक्स्ट भेजें, या एलिमेंट संपादन:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
-d '{"edits": [{"op": "create", "kind": "attribute", "owner": "Vehicles::Car", "name": "range", "typedBy": ["LengthValue"]}]}' \
https://app.holarch.app/api/v1/projects/<project>/proposal/changes
आपको प्रस्ताव, बदलाव का सारांश और उन एलिमेंट के साथ 201 मिलता है जिन्हें वह जोड़ता, बदलता और निकालता है। त्रुटि डायग्नोस्टिक जोड़ने वाला बदलाव अस्वीकार होता है (देखें SysML v2 प्रोजेक्ट में प्रस्ताव)।
- इसी तरह और बदलाव जोड़ें। हर बदलाव को प्रस्ताव के पिछले बदलाव लागू करके मॉडल से जांचा जाता है।
- प्रस्ताव समीक्षा के लिए भेजें:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
-d '{"title": "Add range attribute", "summary": "Adds Car::range for the range requirement."}' \
https://app.holarch.app/api/v1/projects/<project>/proposal
- Holarch में प्रोजेक्ट खोलें, फिर ✦ AI ▾ → “Add range attribute” की समीक्षा करें… खोलें (या घंटी के नीचे की सूचना)।
- पंक्तियां जांचें और चयनित लागू करें पर क्लिक करें।
टिक किए गए बदलाव इतिहास में आपके नाम के साथ लागू होते हैं, और एक ही बार पूर्ववत करने से सब वापस हो जाता है।
AI टूल को SysML v2 प्रोजेक्ट से जोड़ें
- AI टूल को टोकन या साइन-इन से
https://app.holarch.app/mcpसे जोड़ें (देखें API और MCP)। - मॉडल के बारे में पूछें, उदाहरण के लिए “Holarch में Hybrid Car मॉडल का सारांश दें” या “Hybrid Car प्रोजेक्ट में कौन सी आवश्यकताएं सत्यापित नहीं हैं?”।
AI टूल
model_summary,list_elements,list_requirementsऔर दूसरे पढ़ने वाले टूल का उपयोग करता है। - कोई बदलाव मांगें, उदाहरण के लिए “
Carपर एकrangeattribute प्रस्तावित करें”।AI टूल
get_sysmlसे पैकेज पढ़ता है, टेक्स्ट या एलिमेंट संपादन प्रस्तावित करता है, और जांच से लौटे किसी भी डायग्नोस्टिक को ठीक करता है। - Holarch में प्रस्ताव की समीक्षा करें और चयनित लागू करें पर क्लिक करें।
हल किया गया उदाहरण: Hybrid Car डेमो
प्रोजेक्ट प्रबंधित करें → प्रोजेक्ट फ़ाइलें ▾ → नया डेमो प्रोजेक्ट → Hybrid Car (SysML v2) से डेमो बनाएं, फिर उसके लिए पढ़ने-और-लिखने वाला टोकन बनाएं।
GET /api/v1/projects/<project>/modelशीर्ष-स्तरीय पैकेज सूचीबद्ध करता है, जिनमेंVehicles,HybridCarArchitectureऔरVehicleBehaviorहैं।GET /api/v1/projects/<project>/elements?query=Engine&type=part%20defVehicles::Engineढूंढता है।GET /api/v1/projects/<project>/elements/Vehicles::Enginepart definition को उसके SysML टेक्स्ट, उसके सदस्यों (displacement,cylinders,maxPower, portsfuelIn,outputऔरecu) और उससे टाइप किए गए usages के साथ लौटाता है।GET /api/v1/projects/<project>/elements/Vehicles::Car/connectionspowertrain.outputसेfrontAxle.inputतक interfacedriveShaftसूचीबद्ध करता है।GET /api/v1/projects/<project>/requirements?status=unverifiedउन आवश्यकताओं को सूचीबद्ध करता है जिन्हें कोई verification case सत्यापित नहीं करता, उनकेVR-4.1जैसे id के साथ।{"edits": [{"op": "update", "id": "Vehicles::Engine", "doc": "Gasoline engine of the hybrid powertrain."}]}के साथPOST /api/v1/projects/<project>/proposal/changesबदलाव को प्रस्ताव में जोड़ता है। शीर्षक के साथPOST /api/v1/projects/<project>/proposalउसे भेजता है।- Holarch में, ✦ AI ▾ → “…” की समीक्षा करें part definition और फ़ील्ड
docके साथ बदला गया:, औरVehiclesका टेक्स्ट diff दिखाता है। चयनित लागू करें उसे लागू करता है।
सुझाव
- किसी पैकेज के लिए नया टेक्स्ट प्रस्तावित करने से पहले उसे
get_sysml(याGET …/sysml?root=) से पढ़ें। प्रस्तावित टेक्स्ट से छूटे एलिमेंट निकाल दिए जाते हैं। - छोटे बदलावों के लिए एलिमेंट संपादन को प्राथमिकता दें। वे केवल नाम दिए गए एलिमेंट बदलते हैं और पैकेज का बाकी टेक्स्ट जैसा है वैसा रखते हैं।
- पहले
check_sysml(याPOST …/sysml/check) से टेक्स्ट जांचें। यह वही डायग्नोस्टिक लौटाता है जिनके साथ कोई प्रस्ताव अस्वीकार होता। - स्क्रिप्ट में एलिमेंट को पूर्ण नाम से नामित करें। एलिमेंट का नाम बदलने पर id वही रहते हैं; पूर्ण नाम नहीं।
- जब AI टूल केवल मॉडल के बारे में प्रश्नों के उत्तर देता हो, तो उसे केवल पढ़ने वाला टोकन दें।
SysML v2 प्रोजेक्ट के लिए REST रूट
मूल पता: https://app.holarch.app/api/v1। उत्तर JSON में होते हैं। /api/v1/openapi.json (OpenAPI 3.1) इन रूट का दूसरों के साथ वर्णन करता है।
| विधि और पाथ | यह क्या करता है |
|---|---|
GET /projects/<project>/model | हर metaclass के एलिमेंट की संख्या, शीर्ष-स्तरीय पैकेज उनके एलिमेंट की संख्या के साथ, और त्रुटियों और चेतावनियों की संख्या |
GET /projects/<project>/elements | खोज: query (या q; नाम, संक्षिप्त नाम, पूर्ण नाम या doc में टेक्स्ट), type, owner, limit (1–500, डिफ़ॉल्ट 50), offset; पूर्ण नाम से क्रमबद्ध |
GET /projects/<project>/elements/<id> | एक एलिमेंट उसके फ़ील्ड, doc, SysML टेक्स्ट, सदस्यों और उससे टाइप किए गए usages के साथ; members (0–200, डिफ़ॉल्ट 100) |
GET /projects/<project>/elements/<id>/connections | एलिमेंट या उसके features पर connections, interfaces, bindings, flows (item के साथ), successions, transitions, allocations और dependencies, और उसके भीतर स्वामित्व वाले; limit (डिफ़ॉल्ट 100) |
GET /projects/<project>/requirements | आवश्यकताएं उनके id, कथन (doc), satisfiedBy और verifiedBy के साथ; owner, status (unsatisfied या unverified), limit (डिफ़ॉल्ट 100), offset |
GET /projects/<project>/diagnostics | मॉडल के डायग्नोस्टिक, त्रुटियां पहले; ids (अल्पविराम से अलग: केवल वे एलिमेंट और उनके सदस्य), limit (डिफ़ॉल्ट 200, अधिकतम 500) |
GET /projects/<project>/sysml | किसी शीर्ष-स्तरीय पैकेज (root), पैकेज के बाहर के एलिमेंट (कोई root नहीं), या एक एलिमेंट (element) का SysML टेक्स्ट; line (पहली पंक्ति, 1 से), lines (डिफ़ॉल्ट 2000, अधिकतम 5000) |
POST /projects/<project>/sysml/check | text को root (या पैकेज के बाहर के एलिमेंट) के नए टेक्स्ट के रूप में जांचें; कुछ नहीं बदलता |
POST /projects/<project>/proposal/changes | खुले प्रस्ताव में एक बदलाव जोड़ें: {text, root} या {edits} |
GET /projects/<project>/proposal | खुला प्रस्ताव, या proposal id से कोई प्रस्ताव, उसकी स्थिति और बदलावों के साथ |
POST /projects/<project>/proposal | खुला प्रस्ताव समीक्षा के लिए भेजें: title, summary |
DELETE /projects/<project>/proposal | खुले प्रस्ताव को भेजे जाने से पहले हटा दें |
GET /projects और GET /projects/<project> SysML v2 प्रोजेक्ट के लिए भी काम करते हैं। वे "language": "sysml2" देते हैं, और प्रोजेक्ट का उत्तर elements और types (हर metaclass के एलिमेंट की संख्या) जोड़ता है।
LML एंटिटी रूट (/entities, /relationships, /schema, मॉडल जांच और गुणवत्ता जांच) SysML v2 प्रोजेक्ट में 409 wrong-project-type उत्तर देते हैं। SysML v2 रूट LML प्रोजेक्ट में यही उत्तर देते हैं।
मान
- type:
PartUsageयाRequirementDefinitionजैसा कोई metaclass, या SysML टेक्स्ट में लिखा कोई कीवर्ड:part,part def,attribute,port,requirement,action,packageऔर दूसरे एलिमेंट कीवर्ड। - owner, id, element, root: एक id या पूर्ण नाम।
rootकिसी शीर्ष-स्तरीय पैकेज का नाम भी लेता है।rootशीर्ष-स्तरीय पैकेज होना चाहिए; एक एलिमेंट का टेक्स्ट पढ़ने के लिएelementका उपयोग करें। - लंबे मान: सूची में doc 4,000 वर्णों पर, एकल एलिमेंट का doc 20,000 पर, और एलिमेंट का अपना SysML टेक्स्ट 16,000 वर्णों पर काटा जाता है।
SysML v2 प्रोजेक्ट के लिए MCP टूल
MCP एंडपॉइंट इन टूल को LML टूल के साथ सूचीबद्ध करता है। AI टूल list_projects (language: sysml2) से SysML v2 प्रोजेक्ट ढूंढता है। हर टूल project लेता है।
पढ़ने वाले टूल एक वैकल्पिक change_request (CR-12 या उसका id) भी लेते हैं, ताकि मॉडल को वैसा पढ़ सकें जैसा वह परिवर्तन अनुरोध उसे बनाएगा; propose_sysml और propose_element_changes एक लेते हैं, ताकि बदलाव की गणना अनुरोध के मॉडल पर करें और समीक्षा के बाद उसे उस ड्राफ़्ट में लागू करें। नियमों के लिए परिवर्तन अनुरोध देखें।
| टूल | पहुँच | यह क्या करता है |
|---|---|---|
model_summary | पढ़ें | हर metaclass के एलिमेंट की संख्या, शीर्ष-स्तरीय पैकेज और डायग्नोस्टिक की संख्या |
list_elements | पढ़ें | टेक्स्ट (query), type और owner से एलिमेंट ढूंढें; limit और offset से पेज में |
get_element | पढ़ें | एक एलिमेंट (id) उसके प्रकारों, specializations, multiplicity, मान, सिरों, doc, SysML टेक्स्ट, सदस्यों (members, अधिकतम 200) और उससे टाइप किए गए usages के साथ |
get_connections | पढ़ें | किसी एलिमेंट के connections, interfaces, bindings, flows, successions, transitions, allocations और dependencies (id, limit) |
list_requirements | पढ़ें | आवश्यकताएं उनके id, कथन, satisfy और verify के साथ; owner, status (unsatisfied, unverified), limit, offset |
get_sysml | पढ़ें | किसी शीर्ष-स्तरीय पैकेज (root), पैकेज के बाहर के एलिमेंट, या एक एलिमेंट (element) का SysML टेक्स्ट; line, lines (अधिकतम 5000); उत्तर next देता है |
get_sysml_text | पढ़ें | पूरे मॉडल (हर शीर्ष-स्तरीय पैकेज, फिर पैकेज के बाहर के एलिमेंट) या एक package का SysML टेक्स्ट, हर उत्तर में 200,000 वर्णों तक; उत्तर छोड़े गए पैकेजों के नाम बताता है |
check_sysml | पढ़ें | text के बिना: मॉडल के डायग्नोस्टिक (ids, limit)। text (और root) के साथ: पंक्ति और कॉलम के साथ सिंटैक्स त्रुटियां, और वे त्रुटियां जो टेक्स्ट जोड़ेगा। कुछ नहीं बदलता |
propose_sysml | पढ़ें और लिखें | किसी शीर्ष-स्तरीय पैकेज (root), या पैकेज के बाहर के एलिमेंट (कोई root नहीं; नया पैकेज भी यहीं जाता है) का पूरा नया text प्रस्तावित करें |
propose_element_changes | पढ़ें और लिखें | टेक्स्ट दोबारा लिखे बिना edits (अधिकतम 100) प्रस्तावित करें: बनाएं, अपडेट करें, स्थानांतरित करें या निकालें |
list_diagrams, get_diagram और get_matrix SysML v2 प्रोजेक्ट में भी काम करते हैं: list_diagrams व्यू (उनके प्रकार के साथ, जैसे InterconnectionView) और किसी एलिमेंट के नीचे रखे विश्लेषण आरेख सूचीबद्ध करता है; get_diagram वे एलिमेंट देता है जिन्हें कोई व्यू अपने फ़िल्टर के बाद दिखाता है (एलिमेंट id या पूर्ण नाम से); get_matrix हर आवश्यकता को उसे संतुष्ट और सत्यापित करने वालों के साथ देता है।
LML प्रोजेक्ट के प्रस्ताव टूल यहाँ भी उसी तरह काम करते हैं: propose_changes प्रस्ताव को शीर्षक और सारांश के साथ भेजता है, discard_proposal उसे हटाता है, और get_proposal और list_proposals उसकी स्थिति दिखाते हैं। केवल पढ़ने वाला टोकन केवल पढ़ने वाले टूल सूचीबद्ध करता है।
टूल त्रुटियां संदेश और डायग्नोस्टिक के साथ टूल परिणाम के रूप में लौटती हैं, ताकि AI टूल अपना टेक्स्ट ठीक करके दोबारा प्रयास कर सके।
एलिमेंट संपादन
edits (MCP) या {"edits": […]} (REST) में हर संपादन op वाला एक ऑब्जेक्ट है:
| op | फ़ील्ड |
|---|---|
create | kind (part, part def, attribute, port, requirement, action, package जैसा कोई कीवर्ड) या type (एक metaclass); owner (छोड़ा गया: शीर्ष स्तर); name (आवश्यक); वैकल्पिक shortName, typedBy, specializes, subsets, redefines, multiplicity, value, doc, direction (in, out, inout) |
update | id और बदलने वाले फ़ील्ड, create की तरह; null या "" फ़ील्ड खाली करता है |
move | id और नया owner |
remove | id; एलिमेंट को उसके सदस्यों के साथ निकालता है |
typedBy,specializes,subsetsऔरredefines20 तक नामों की सूचियां हैं: id, पूर्ण नाम, या टेक्स्ट में लिखे नाम (MassValueजैसे लाइब्रेरी नाम काम करते हैं)।- बाद के संपादन उसी कॉल में पहले बनाए गए एलिमेंट को बनाए जाने के क्रम में
new:1,new:2… के रूप में नामित कर सकते हैं, उदाहरण के लिएownerके रूप में। उत्तर उन्हें उनके नए id के साथcreatedके नीचे सूचीबद्ध करता है। - किसी एलिमेंट का नाम बदलने से वे संदर्भ भी अपडेट होते हैं जो उसे पुराने नाम से नामित करते थे।
प्रस्तावित टेक्स्ट
propose_sysmlपैकेज का पूरा टेक्स्ट बदल देता है। जहाँ टेक्स्ट अब भी एलिमेंट घोषित करता है, वहाँ वे अपने id रखते हैं। टेक्स्ट से छूटे एलिमेंट निकाल दिए जाते हैं।- टेक्स्ट बिना कुछ लागू हुए छोड़े पार्स होना चाहिए। मॉडल न बदलने वाला टेक्स्ट अस्वीकार होता है (
no-change)।
SysML v2 प्रोजेक्ट में प्रस्ताव
हर प्रस्तावित बदलाव प्रस्ताव में जुड़ने से पहले भाषा कोर से जांचा जाता है:
- टेक्स्ट बिना सिंटैक्स त्रुटियों के पार्स होता है, और एलिमेंट संपादन लागू होते हैं।
- बदले गए पैकेज अब भी SysML टेक्स्ट के रूप में प्रिंट होते हैं और फिर से पार्स होते हैं।
- बदलाव मॉडल में कोई त्रुटि डायग्नोस्टिक नहीं जोड़ता, जैसे अनरिज़ॉल्व्ड नाम या प्रकार त्रुटियां। मॉडल में पहले से मौजूद त्रुटियां नहीं गिनी जातीं।
विफल बदलाव ठीक करने वाले डायग्नोस्टिक (50 तक) के साथ अस्वीकार होता है। कुछ भी संग्रहीत नहीं होता। चेतावनियां किसी बदलाव को अस्वीकार नहीं करतीं।
प्रस्तावित करने के लिए पढ़ने-और-लिखने वाला टोकन और प्रोजेक्ट में संपादक या स्वामी भूमिका चाहिए। एक प्रस्ताव में अधिकतम 200 बदलाव और 8 MB होते हैं।
SysML v2 प्रस्ताव की समीक्षा करें
प्रोजेक्ट खोलें, फिर ✦ AI ▾ → “<title>” की समीक्षा करें…। हर बदलाव चेकबॉक्स वाली एक पंक्ति है:
- जोड़ा गया, बदला गया और निकाला गया एलिमेंट को बदले गए फ़ील्ड के साथ सूचीबद्ध करते हैं (हर एक के पहले 20; बाकी के लिए “और n”)।
- पैकेज के लेबल वाला टेक्स्ट diff पहले और बाद का SysML टेक्स्ट दिखाता है।
- एलिमेंट निकालने वाला बदलाव चिह्नित होता है और बिना टिक के शुरू होता है।
- यह बदलाव लागू करने के लिए SysML v2 मॉडल खोलें। मॉडल लोड नहीं है; प्रोजेक्ट का कोई SysML v2 पेज खोलें।
- पैकेज अब मॉडल में नहीं है; छोड़ा गया। बदलाव प्रस्तावित होने के बाद पैकेज निकाल दिया गया।
चयनित लागू करें हर टेक्स्ट बदलाव को मौजूदा मॉडल से फिर से सिंक करता है और वे संपादन रखता है जिनके एलिमेंट अब भी मौजूद हैं। यह पूरे सेट को जांचता है और उसे एक पूर्ववत चरण के रूप में लागू करता है। जो बदलाव अब फ़िट नहीं होते, वे छोड़े जाते हैं और सूचना में नामित होते हैं। अस्वीकार करें और बाद में LML प्रस्तावों की तरह काम करते हैं, और भूमिकाएं, समाप्ति (7 दिन) और प्रतिधारण भी (देखें AI क्लाइंट से प्रस्ताव)।
Systems Modeling API
दूसरे SysML v2 टूल OMG Systems Modeling API (REST/HTTP) के आकार वाले रूट से Holarch मॉडल पढ़ते और बदलते हैं। मूल पता https://app.holarch.app/api/v1/sysml है। यह वही टोकन उपयोग करता है; कोई भी प्रोजेक्ट भूमिका पढ़ सकती है, और संपादक और स्वामी कमिट कर सकते हैं।
- प्रोजेक्ट: केवल SysML v2 प्रोजेक्ट सूचीबद्ध होते हैं। किसी प्रोजेक्ट का
@idएक UUID है जो यह API उसे देता है; Holarch प्रोजेक्ट id भी काम करता है। उत्तर मेंholarchIdऔरurlशामिल होते हैं। - ब्रांच:
mainलाइव मॉडल है और API से बदला नहीं जा सकता। हर दूसरी ब्रांच प्रगति में एक परिवर्तन अनुरोध है, जिसका नाम "CR-12 Title" होता है और जोholarchChangeRequest(id,label,status,url) रखती है। पिछले 30 दिनों में लागू या वापस लिए गए परिवर्तन अनुरोधdeletedसेट के साथ अब भी सूचीबद्ध होते हैं। - कमिट: कमिट किसी परिवर्तन अनुरोध की ब्रांच में बदलाव लिखता है। केवल ब्रांच हेड दिए जाते हैं:
mainका हेड लाइव मॉडल है, परिवर्तन अनुरोध ब्रांच का हेड अनुरोध के बदलावों के साथ लाइव मॉडल है। पुराने कमिट id404उत्तर देते हैं; मौजूदा हेड ब्रांच से प्राप्त करें। - एलिमेंट: हर एलिमेंट में OMG JSON स्कीमा में उसके metaclass का हर गुण होता है, व्युत्पन्न गुणों सहित (
owner,ownedElement,qualifiedName,feature,typeआदि)। मानक लाइब्रेरी एलिमेंट का संदर्भ उनके मानक id से दिया जाता है, वही id जो दूसरे SysML v2 टूल उसी लाइब्रेरी एलिमेंट के लिए उपयोग करते हैं। - टैग और सहेजी गई क्वेरी: कोई नहीं; उनकी सूचियां खाली हैं।
| विधि और पाथ | यह क्या करता है |
|---|---|
GET /sysml/projects | आपके SysML v2 प्रोजेक्ट |
POST /sysml/projects | खाली SysML v2 प्रोजेक्ट बनाएं (name, description) |
GET /sysml/projects/<projectId> | एक प्रोजेक्ट, उसकी डिफ़ॉल्ट ब्रांच के साथ |
GET /sysml/projects/<projectId>/branches | main और परिवर्तन अनुरोध ब्रांच |
POST /sysml/projects/<projectId>/branches | ब्रांच बनाएं: एक नया Draft परिवर्तन अनुरोध (name उसका शीर्षक, description उसका कारण) |
GET /sysml/projects/<projectId>/branches/<branchId> | ब्रांच (उसका @id या main), head के साथ |
DELETE /sysml/projects/<projectId>/branches/<branchId> | परिवर्तन अनुरोध वापस लें |
GET /sysml/projects/<projectId>/commits | हेड और ब्रांच को भेजे गए कमिट, सबसे नए पहले |
POST /sysml/projects/<projectId>/commits?branchId=<branchId> | किसी ब्रांच में बदलाव कमिट करें (नीचे) |
GET /sysml/projects/<projectId>/commits/<commitId> | एक हेड कमिट |
GET /sysml/projects/<projectId>/commits/<commitId>/changes | ब्रांच लाइव मॉडल की तुलना में क्या बदलती है: हर एलिमेंट के लिए एक DataVersion |
GET /sysml/projects/<projectId>/commits/<commitId>/elements | कमिट के सभी एलिमेंट, पेज में |
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId> | एक एलिमेंट |
GET /sysml/projects/<projectId>/commits/<commitId>/roots | शीर्ष-स्तरीय एलिमेंट, पेज में |
GET /sysml/projects/<projectId>/commits/<commitId>/elements/<elementId>/relationships | वे संबंध जिनमें एलिमेंट स्रोत या लक्ष्य है; direction in, out या both (डिफ़ॉल्ट) है, पेज में |
POST /sysml/projects/<projectId>/query-results | किसी क्वेरी (नीचे बॉडी) से मेल खाने वाले एलिमेंट, पेज में; commitId हेड होना चाहिए |
GET /sysml/projects/<projectId>/tags, /queries, /commits/<commitId>/elements/<elementId>/projectUsages | खाली सूचियां |
सूची उत्तर JSON arrays होते हैं। सूचियां page[size] (डिफ़ॉल्ट 100, अधिकतम 1000) और page[after] (पिछले पेज के अंतिम आइटम का @id) या page[before] (अगले पेज के पहले आइटम का @id) से पेज में आती हैं। Link हेडर अगला पेज rel="next" के साथ और पिछला rel="prev" के साथ देता है।
क्वेरी एक JSON ऑब्जेक्ट है जिसमें वैकल्पिक where (property, operator (=, in, <, <=, >, >= या instanceOf), value और inverse वाला एक PrimitiveConstraint, या operator and या or और constraint वाला एक CompositeConstraint), scope (एलिमेंट id: खोज उन्हें और उनके स्वामित्व वाली चीज़ों को कवर करती है) और select (लौटाने वाले गुण; @id और @type हमेशा लौटते हैं) होते हैं:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
"https://app.holarch.app/api/v1/sysml/projects/<projectId>/query-results" \
-d '{"@type": "Query", "where": {"@type": "PrimitiveConstraint", "property": "@type", "operator": "=", "value": "PartDefinition", "inverse": false}, "select": ["name", "qualifiedName"]}'
किसी मॉडल के एलिमेंट पढ़ें:
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/sysml/projects
curl -H "Authorization: Bearer hol_…" https://app.holarch.app/api/v1/sysml/projects/<projectId>/branches/main
curl -i -H "Authorization: Bearer hol_…" "https://app.holarch.app/api/v1/sysml/projects/<projectId>/commits/<head id>/elements?page[size]=500"
बदलाव कमिट करें
लिखने के लिए पढ़ने और लिखने की पहुंच वाला टोकन, संपादक या स्वामी भूमिका, Team प्लान (शैक्षणिक और क्लास खातों के लिए भी), और प्रोजेक्ट के लिए ब्रांच समीक्षा चालू होनी चाहिए (परिवर्तन अनुरोध → सेटिंग्स)। कोई अनुमोदक Holarch में परिवर्तन अनुरोध की समीक्षा करके उसे लागू करता है; टोकन कभी वोट या लागू नहीं करते।
- ब्रांच बनाएं:
{"@type": "Branch", "name": "Cabin heater"}के साथ POST/branches। उत्तर उसकेholarchChangeRequestके साथ ब्रांच है। - ब्रांच का हेड और उसके एलिमेंट पढ़ें।
DataVersionकी सूची के साथ POST/commits?branchId=<branch @id>:
curl -X POST -H "Authorization: Bearer hol_…" -H "Content-Type: application/json" \
"https://app.holarch.app/api/v1/sysml/projects/<projectId>/commits?branchId=<branch id>" \
-d '{"@type": "Commit", "description": "Add the heater",
"previousCommit": {"@id": "<head id>"},
"change": [{"@type": "DataVersion", "identity": {"@id": "<new uuid>"},
"payload": {"@type": "PartDefinition", "declaredName": "CabinHeater", "owner": {"@id": "<package id>"}}}]}'
- किसी एलिमेंट को बदलना: एलिमेंट को वैसे ही भेजें जैसे आपने उसे पढ़ा था, गुण बदलकर। केवल स्वामित्व वाले गुण गिने जाते हैं (
declaredName,ownedRelationship,isAbstractआदि); व्युत्पन्न गुण अनदेखे होते हैं, इसलिए पढ़ा हुआ वापस भेजने से कुछ नहीं बदलता। जो गुण आप छोड़ते हैं, वह अपना मान रखता है; उसे खाली करने के लिएnullया[]भेजें। - नए एलिमेंट: एलिमेंट को एक नया UUID दें और या तो उसकी owning membership (उसी कमिट में भेजी गई) या
owner, जो आपके लिए membership बनाता है। - किसी एलिमेंट को निकालना:
payload: nullउसे उसके स्वामित्व की हर चीज़ के साथ निकालता है। - जांच: कमिट जिस पैकेज को छूता है, वह फिर से प्रिंट और पार्स होना चाहिए, और कमिट को त्रुटि डायग्नोस्टिक नहीं जोड़ने चाहिए; वरना ठीक करने वाले
diagnosticsके साथ422। - previousCommit: वह हेड जिस पर आपका बदलाव किया गया था। अगर तब से ब्रांच आगे बढ़ गई है, तो उत्तर मौजूदा
headके साथ409stale-headहोता है; फिर से पढ़ें और उसके ऊपर कमिट करें। - पुनः प्रयास: एक
Idempotency-Keyहेडर भेजें। 24 घंटे के भीतर उसी key और बॉडी के साथ पुनः प्रयास को पहला उत्तर फिर से मिलता है। mainपर कमिट:branchIdके बिना, याmainके साथ कमिट आपके टोकन के अपने ड्राफ़्ट परिवर्तन अनुरोध ("API changes from <token name>") में जाता है, जो ऐसे पहले कमिट पर बनता है। उत्तरholarchChangeRequestमें और एकWarningहेडर में बताता है कि कौन सा।- नए प्रोजेक्ट: POST
/sysml/projectsसे बने प्रोजेक्ट में ब्रांच समीक्षा चालू होती है।mainपर उसका पहला कमिट, जब आप उसके एकमात्र सदस्य हों, सीधे मॉडल में एक बार लिखा जाता है; बाद के कमिट परिवर्तन अनुरोधों से होकर जाते हैं।
परिवर्तन अनुरोध को POST /api/v1/projects/<project>/change-requests/<CR-12>/submit से समीक्षा के लिए सबमिट करें (API और MCP)। टैग, मर्ज और किसी प्रोजेक्ट का नाम बदलना या हटाना 405 उत्तर देते हैं, साथ में बताते हैं कि इसके बजाय क्या करें। त्रुटियों में @type Error और एक description होता है, जैसा OMG API उन्हें परिभाषित करता है।
संदेश
API और MCP के कोड लागू होते हैं। SysML v2 रूट और टूल ये जोड़ते हैं:
| कोड | स्थिति | अर्थ |
|---|---|---|
wrong-project-type | 409 | SysML v2 प्रोजेक्ट में LML कार्रवाई, या LML प्रोजेक्ट में SysML v2 कार्रवाई |
syntax | 422 | प्रस्तावित टेक्स्ट में सिंटैक्स त्रुटियां हैं; डायग्नोस्टिक पंक्ति और कॉलम देते हैं |
invalid-model | 422 | बदलाव मॉडल में त्रुटि डायग्नोस्टिक जोड़ता है; वे सूचीबद्ध हैं |
not-printable | 422 | बदलाव SysML टेक्स्ट के रूप में नहीं लिखा जा सकता |
invalid | 422 | बदलाव मॉडल पर लागू नहीं हो सका |
no-change | 400 | टेक्स्ट मॉडल नहीं बदलता |
too-large | 413 | टेक्स्ट 1,000,000 वर्णों से लंबा है, या प्रस्ताव 8 MB से बड़ा है |
too-many | 413 या 409 | एक कॉल में 100 से अधिक संपादन (413), या प्रस्ताव में पहले से 200 बदलाव हैं (409) |
stale | 409 | प्रस्ताव का पहले का कोई टेक्स्ट बदलाव अब मॉडल पर लागू नहीं होता |
not-found | 404 | ऐसा कोई प्रोजेक्ट, एलिमेंट, ब्रांच या कमिट नहीं (Systems Modeling API केवल ब्रांच हेड देता है) |
not-writable | 405 | Systems Modeling API से टैग, मर्ज, किसी प्रोजेक्ट का नाम बदलना या हटाना; इसे Holarch में करें |
main-protected | 405 | main हटाना; इसके बजाय कोई परिवर्तन अनुरोध ब्रांच हटाएं |
stale-head | 409 | previousCommit के बाद ब्रांच आगे बढ़ गई है; उसका head पढ़ें और फिर से कमिट करें |
branch-base | 409 | नई ब्रांच main के हेड से शुरू होनी चाहिए |
branch-review-off | 409 | प्रोजेक्ट ब्रांच समीक्षा का उपयोग नहीं करता; कोई स्वामी इसे परिवर्तन अनुरोध → सेटिंग्स में चालू करता है |
cr-not-draft | 409 | परिवर्तन अनुरोध सबमिट या बंद है; इसे केवल Draft या Rejected रहते लिखा जा सकता है |
cr-full | 409 | परिवर्तन अनुरोध में 5,000 बदले गए आइटम हैं, या प्रोजेक्ट में 20 MB के परिवर्तन अनुरोध ड्राफ़्ट हैं |
plan-limit | 403 | परिवर्तन अनुरोधों में लिखने के लिए Team प्लान चाहिए |
orphan | 422 | नए एलिमेंट का कोई स्वामी नहीं है; उसकी owning membership या owner भेजें |
unknown-metaclass | 422 | किसी payload का @type SysML v2 metaclass नहीं है |
idempotency-key-reused | 422 | Idempotency-Key का उपयोग दूसरी बॉडी के साथ हुआ था; नई key भेजें |
token-projects | 403 | प्रोजेक्ट की सूची तक सीमित टोकन प्रोजेक्ट नहीं बना सकता |
bad-request | 400 | कोई गायब या गलत मान, जैसे ऐसा root जो शीर्ष-स्तरीय पैकेज नहीं है, कोई अज्ञात op या बिना नाम का नया एलिमेंट |
सीमाएं
| क्या | सीमा |
|---|---|
| हर पेज में एलिमेंट, आवश्यकताएं या connections | 500 |
| किसी एलिमेंट के साथ सूचीबद्ध सदस्य | 200 |
| हर उत्तर में डायग्नोस्टिक | 500 |
| हर उत्तर में SysML टेक्स्ट की पंक्तियां | 5,000, और अधिकतम 400,000 बाइट (किसी पंक्ति पर काटा गया) |
| Doc टेक्स्ट | सूचियों में 4,000 वर्ण, एक एलिमेंट के लिए 20,000 |
| किसी एलिमेंट का अपना SysML टेक्स्ट | 16,000 वर्ण |
एक propose_sysml कॉल में टेक्स्ट | 1,000,000 वर्ण |
| एक कॉल में संपादन | 100 |
| एक बदलाव में जोड़े, बदले या निकाले गए के रूप में सूचीबद्ध एलिमेंट | हर एक 300 |
| एक प्रस्ताव में बदलाव | 200, और 8 MB |
| Systems Modeling API पेज | 1,000 एलिमेंट (डिफ़ॉल्ट 100) |
| एक कमिट में DataVersions | 5,000 |
| एक परिवर्तन अनुरोध में बदले गए आइटम | 5,000 |
| कमिट बॉडी | 32 MB |
दर सीमाएं, अनुरोध का आकार और टोकन नियम API और MCP वाले ही हैं।
संबंधित पेज
- API और MCP
- SysML v2 प्रोजेक्ट के साथ शुरुआत करना
- टेक्स्ट एडिटर और ब्राउज़र
- SysML v2 मॉडल का आदान-प्रदान
- SysML v2 प्रोजेक्ट में आवश्यकताएं और सत्यापन
SysML® और OMG®, संयुक्त राज्य अमेरिका और अन्य देशों में Object Management Group, Inc. के पंजीकृत ट्रेडमार्क हैं।